> For the complete documentation index, see [llms.txt](https://docs.infraon.io/infraon-infinity-api-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.infraon.io/infraon-infinity-api-guide/modules/discovery-configuration.md). # Discovery Configuration ## Gets a list of discovery configurations > This endpoint is used to fetch all the discovery configurations in the current organization (works based on token used to authorize) ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/ux/ims/discovery/profile/":{"get":{"operationId":"ux_ims_discovery_profile_retrieve","description":"This endpoint is used to fetch all the discovery configurations in the current organization (works based on token used to authorize)","summary":"Gets a list of discovery configurations","parameters":[{"in":"query","name":"items_per_page","schema":{"type":"integer"},"description":"Items Per Page","required":true},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page Number","required":true},{"in":"query","name":"reverse","schema":{"type":"boolean"},"description":"Sorting Order"},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sorting Key"}],"tags":["Discovery Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"description":""}}}}}} ``` ## Creates a new discovery configuration > This endpoint is used to save a new discovery configuration for the current organization ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/ux/ims/discovery/profile/":{"post":{"operationId":"ux_ims_discovery_profile_create","description":"This endpoint is used to save a new discovery configuration for the current organization","summary":"Creates a new discovery configuration ","tags":["Discovery Configuration"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"status":"success","job_id":20,"message":"discovery configuration created"}}},"description":""}}}}}} ``` ## Gets a discovery configuration with the given id > This endpoint is used to fetch a discovery configuration in the current organization ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/{id}/":{"get":{"operationId":"ux_ims_discovery_profile_retrieve_2","description":"This endpoint is used to fetch a discovery configuration in the current organization","summary":"Gets a discovery configuration with the given id","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Discovery Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## Edits the discovery configuration with given id > This endpoint is used to edit an existing discovery configuration for the current organization ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/{id}/":{"put":{"operationId":"ux_ims_discovery_profile_update","description":"This endpoint is used to edit an existing discovery configuration for the current organization","summary":"Edits the discovery configuration with given id","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Discovery Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## Deletes the discovery configuration with given id > This endpoint is used to delete an existing discovery configuration for the current organization ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/ux/ims/discovery/profile/{id}/":{"delete":{"operationId":"ux_ims_discovery_profile_destroy","description":"This endpoint is used to delete an existing discovery configuration for the current organization","summary":"Deletes the discovery configuration with given id","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Discovery Configuration"],"responses":{"204":{"description":"No response body"}}}}}} ``` ## Get the audit for the discovery configuration > This endpoint is used to get the audit for the given discovery job id ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/audit/":{"get":{"operationId":"ux_ims_discovery_profile_audit_retrieve","description":"This endpoint is used to get the audit for the given discovery job id","summary":"Get the audit for the discovery configuration","tags":["Discovery Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## Get the detailed discovery configuration > This endpoint is used to get the detailed configuration of the discovery job id provided ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/details/":{"get":{"operationId":"ux_ims_discovery_profile_details_retrieve","description":"This endpoint is used to get the detailed configuration of the discovery job id provided","summary":"Get the detailed discovery configuration","tags":["Discovery Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## Get the iterations for the discovery configuration > This endpoint is used to get all the iterations for the given discovery job id ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/do-rescan/":{"post":{"operationId":"ux_ims_discovery_profile_do_rescan_create","description":"This endpoint is used to get all the iterations for the given discovery job id","summary":"Get the iterations for the discovery configuration","tags":["Discovery Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## GET /ux/ims/discovery/profile/download\_csv/ > API endpoint that allows discovery configurations to be viewed or edited. ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/download_csv/":{"get":{"operationId":"ux_ims_discovery_profile_download_csv_retrieve","description":"API endpoint that allows discovery configurations to be viewed or edited.","tags":["Discovery Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## Gets a scanning mechanism List with the given id > This endpoint is used to fetch a custom scanning mechanism List with the options in the current organization ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/get-custom-scanner-fields/":{"post":{"operationId":"ux_ims_discovery_profile_get_custom_scanner_fields_create","description":"This endpoint is used to fetch a custom scanning mechanism List with the options in the current organization","summary":"Gets a scanning mechanism List with the given id","tags":["Discovery Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## Get the iterations for the discovery configuration > This endpoint is used to get all the iterations for the given discovery job id ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/iteration-list/":{"get":{"operationId":"ux_ims_discovery_profile_iteration_list_retrieve","description":"This endpoint is used to get all the iterations for the given discovery job id","summary":"Get the iterations for the discovery configuration","tags":["Discovery Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## POST /ux/ims/discovery/profile/multidelete/ > API endpoint that allows discovery configurations to be viewed or edited. ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/multidelete/":{"post":{"operationId":"ux_ims_discovery_profile_multidelete_create","description":"API endpoint that allows discovery configurations to be viewed or edited.","tags":["Discovery Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## Get the discovery dropdown and config options > This endpoint is used to get the general options for dropdowns and UI elements ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/options/":{"get":{"operationId":"ux_ims_discovery_profile_options_retrieve","description":"This endpoint is used to get the general options for dropdowns and UI elements","summary":"Get the discovery dropdown and config options","tags":["Discovery Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` ## POST /ux/ims/discovery/profile/validate\_csv/ > API endpoint that allows discovery configurations to be viewed or edited. ```json {"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"DiscoveryConfiguration":{"type":"object","description":"Discovery Configuration serializers","properties":{"id":{"type":"string","readOnly":true},"sdwan_vendor":{"type":"string","readOnly":true},"edgeDevice_credentials":{"type":"string","readOnly":true},"last_update_time":{"type":"string","readOnly":true},"job_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"organization":{"type":"string"},"agent_id":{"type":"string"},"host":{"type":"string"},"secondary_host":{"type":"string"},"params":{"type":"object","additionalProperties":{}},"credentials":{"type":"array","items":{}},"configuration_credentials":{"type":"array","items":{}},"add_to_nccm":{"type":"boolean"},"filter":{"type":"array","items":{}},"schedule":{"type":"object","additionalProperties":{}},"protocol":{"type":"array","items":{}},"configuration_protocol":{"type":"array","items":{}},"is_csv_upload":{"type":"integer"},"csv_data":{"type":"array","items":{}},"created_by":{"type":"integer"},"modified_by":{"type":"integer"},"creation_time":{"type":"string","format":"date-time"},"is_deleted":{"type":"boolean"},"job_iteration_id":{"type":"string"},"last_scan_result":{"type":"object","additionalProperties":{}},"configuration_download":{"type":"boolean"},"download_params":{"type":"object","additionalProperties":{}},"customer_id":{"type":"string"},"customer_entity_id":{"type":"string"}},"required":["edgeDevice_credentials","id","job_id","last_update_time","sdwan_vendor"]}}},"paths":{"/ux/ims/discovery/profile/validate_csv/":{"post":{"operationId":"ux_ims_discovery_profile_validate_csv_create","description":"API endpoint that allows discovery configurations to be viewed or edited.","tags":["Discovery Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConfiguration"}}},"description":""}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.infraon.io/infraon-infinity-api-guide/modules/discovery-configuration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.