Infraon API Guide
Product DocsSchemaAuthentication
  • Welcome
    • Base URL
    • Authorization
    • Responses
  • Modules
    • Schema
    • Authentication
    • Announcement
    • API Registration
    • Async Tasks
    • BusinessRule
    • BusinessServiceConfiguration
    • Service Catalogue
    • CMDBBlacklistWhitelist
    • CMDBCategory
    • CMDBConsumables
    • Ux
    • CMDBSoftwareLicense
    • Cmdb
    • CMDBRelation
    • CMDBSoftware
    • ContractManagement
    • Department
    • Events
    • Field Configuration
    • IMACD
    • Knowledge Base
    • Leaves
    • Chat
    • Marketplace
    • APIViewSet
    • BeepViewSet
    • SMSviewset
    • Suppressedviewset
    • Organization Location
    • Partner
    • Predicted Events
    • Requester
    • Service Feasibility Requests
    • Role Profile
    • Tag
    • Service_outage
    • Teams
    • Telecom Settings
    • Trap Configurations
    • User Profile
    • Vendor Managemment
    • Association Events
    • Device Template
    • Discovery Configuration
    • Jobs
    • MIB Explorer
    • Seasonal Events
    • IPAM
    • Log Grok Pattern Configuration
    • Log Pipeline Configuration
    • Log Integraion
    • Log Search
    • CLI Download Jobs
    • Configuration Profiles
    • Configuration Policies
    • Configuration Rules
    • Configuration Search
    • Configuration Template
    • Configuration Trigger
    • Jobs Account Audit
    • Manage Vulnerabilities
    • OS Image Download
    • Rule Group
    • Configuration Upload Jobs
    • Work Flow Jobs
    • Change
    • Checklist
    • Incident
    • Problem
    • Release
    • Request Process
    • Task
    • Models
Powered by GitBook
On this page
  1. Modules

Discovery Configuration

PreviousDevice TemplateNextJobs

Gets a discovery configuration with the given id

get

This endpoint is used to fetch a discovery configuration in the current organization

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/ims/discovery/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}

Deletes the discovery configuration with given id

delete

This endpoint is used to delete an existing discovery configuration for the current organization

Authorizations
Path parameters
idstringRequired
Responses
204
No response body
delete
DELETE /ux/ims/discovery/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

Get the audit for the discovery configuration

get

This endpoint is used to get the audit for the given discovery job id

Authorizations
Responses
200Success
application/json
get
GET /ux/ims/discovery/profile/audit/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}

Get the detailed discovery configuration

get

This endpoint is used to get the detailed configuration of the discovery job id provided

Authorizations
Responses
200Success
application/json
get
GET /ux/ims/discovery/profile/details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
get

API endpoint that allows discovery configurations to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/ims/discovery/profile/download_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}

Get the iterations for the discovery configuration

get

This endpoint is used to get all the iterations for the given discovery job id

Authorizations
Responses
200Success
application/json
get
GET /ux/ims/discovery/profile/iteration-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}

Get the discovery dropdown and config options

get

This endpoint is used to get the general options for dropdowns and UI elements

Authorizations
Responses
200Success
application/json
get
GET /ux/ims/discovery/profile/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
  • GETGets a list of discovery configurations
  • POSTCreates a new discovery configuration
  • GETGets a discovery configuration with the given id
  • PUTEdits the discovery configuration with given id
  • DELETEDeletes the discovery configuration with given id
  • GETGet the audit for the discovery configuration
  • GETGet the detailed discovery configuration
  • POSTGet the iterations for the discovery configuration
  • GET/ux/ims/discovery/profile/download_csv/
  • POSTGets a scanning mechanism List with the given id
  • GETGet the iterations for the discovery configuration
  • POST/ux/ims/discovery/profile/multidelete/
  • GETGet the discovery dropdown and config options
  • POST/ux/ims/discovery/profile/validate_csv/

Gets a list of discovery configurations

get

This endpoint is used to fetch all the discovery configurations in the current organization (works based on token used to authorize)

Authorizations
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
200Success
application/json
get
GET /ux/ims/discovery/profile/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Creates a new discovery configuration

post

This endpoint is used to save a new discovery configuration for the current organization

Authorizations
Body
Other propertiesanyOptional
Responses
201Success
application/json
Responseany
post
POST /ux/ims/discovery/profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 387

{
  "organization": "532475354328",
  "agent_id": "xxxxxxxxxxxxxx",
  "job_id": "2222222222",
  "host": "192.168.50.1/24",
  "label": "Auto_192.158.50.*",
  "protocol": [
    "snmp",
    "ping"
  ],
  "params": {
    "filter_by_ping": 1,
    "ping_monitor": 1,
    "snmp_monitor": 1,
    "exclude_ip_address": []
  },
  "credentials": [],
  "creation_time": "now",
  "created_by": "admin",
  "schedule": {
    "period": "Daily",
    "hour": "00",
    "min": "00",
    "unit": "Days",
    "days": "0"
  }
}
201Success
{
  "status": "success",
  "job_id": 20,
  "message": "discovery configuration created"
}

Edits the discovery configuration with given id

put

This endpoint is used to edit an existing discovery configuration for the current organization

Authorizations
Path parameters
idstringRequired
Body

Discovery Configuration serializers

idstringRead-onlyRequired
sdwan_vendorstringRead-onlyRequired
edgeDevice_credentialsstringRead-onlyRequired
last_update_timestringRead-onlyRequired
job_idstringRequired
labelstringOptional
descriptionstringOptional
organizationstringOptional
agent_idstringOptional
hoststringOptional
secondary_hoststringOptional
add_to_nccmbooleanOptional
is_csv_uploadintegerOptional
created_byintegerOptional
modified_byintegerOptional
creation_timestring · date-timeOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
configuration_downloadbooleanOptional
customer_idstringOptional
customer_entity_idstringOptional
Responses
200Success
application/json
put
PUT /ux/ims/discovery/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 694

{
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}

Get the iterations for the discovery configuration

post

This endpoint is used to get all the iterations for the given discovery job id

Authorizations
Body

Discovery Configuration serializers

idstringRead-onlyRequired
sdwan_vendorstringRead-onlyRequired
edgeDevice_credentialsstringRead-onlyRequired
last_update_timestringRead-onlyRequired
job_idstringRequired
labelstringOptional
descriptionstringOptional
organizationstringOptional
agent_idstringOptional
hoststringOptional
secondary_hoststringOptional
add_to_nccmbooleanOptional
is_csv_uploadintegerOptional
created_byintegerOptional
modified_byintegerOptional
creation_timestring · date-timeOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
configuration_downloadbooleanOptional
customer_idstringOptional
customer_entity_idstringOptional
Responses
200Success
application/json
post
POST /ux/ims/discovery/profile/do-rescan/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 694

{
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}

Gets a scanning mechanism List with the given id

post

This endpoint is used to fetch a custom scanning mechanism List with the options in the current organization

Authorizations
Body

Discovery Configuration serializers

idstringRead-onlyRequired
sdwan_vendorstringRead-onlyRequired
edgeDevice_credentialsstringRead-onlyRequired
last_update_timestringRead-onlyRequired
job_idstringRequired
labelstringOptional
descriptionstringOptional
organizationstringOptional
agent_idstringOptional
hoststringOptional
secondary_hoststringOptional
add_to_nccmbooleanOptional
is_csv_uploadintegerOptional
created_byintegerOptional
modified_byintegerOptional
creation_timestring · date-timeOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
configuration_downloadbooleanOptional
customer_idstringOptional
customer_entity_idstringOptional
Responses
200Success
application/json
post
POST /ux/ims/discovery/profile/get-custom-scanner-fields/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 694

{
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
post

API endpoint that allows discovery configurations to be viewed or edited.

Authorizations
Body

Discovery Configuration serializers

idstringRead-onlyRequired
sdwan_vendorstringRead-onlyRequired
edgeDevice_credentialsstringRead-onlyRequired
last_update_timestringRead-onlyRequired
job_idstringRequired
labelstringOptional
descriptionstringOptional
organizationstringOptional
agent_idstringOptional
hoststringOptional
secondary_hoststringOptional
add_to_nccmbooleanOptional
is_csv_uploadintegerOptional
created_byintegerOptional
modified_byintegerOptional
creation_timestring · date-timeOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
configuration_downloadbooleanOptional
customer_idstringOptional
customer_entity_idstringOptional
Responses
200Success
application/json
post
POST /ux/ims/discovery/profile/multidelete/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 694

{
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
post

API endpoint that allows discovery configurations to be viewed or edited.

Authorizations
Body

Discovery Configuration serializers

idstringRead-onlyRequired
sdwan_vendorstringRead-onlyRequired
edgeDevice_credentialsstringRead-onlyRequired
last_update_timestringRead-onlyRequired
job_idstringRequired
labelstringOptional
descriptionstringOptional
organizationstringOptional
agent_idstringOptional
hoststringOptional
secondary_hoststringOptional
add_to_nccmbooleanOptional
is_csv_uploadintegerOptional
created_byintegerOptional
modified_byintegerOptional
creation_timestring · date-timeOptional
is_deletedbooleanOptional
job_iteration_idstringOptional
configuration_downloadbooleanOptional
customer_idstringOptional
customer_entity_idstringOptional
Responses
200Success
application/json
post
POST /ux/ims/discovery/profile/validate_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 694

{
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}
200Success
{
  "id": "text",
  "sdwan_vendor": "text",
  "edgeDevice_credentials": "text",
  "last_update_time": "text",
  "job_id": "text",
  "label": "text",
  "description": "text",
  "organization": "text",
  "agent_id": "text",
  "host": "text",
  "secondary_host": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "credentials": [],
  "configuration_credentials": [],
  "add_to_nccm": true,
  "filter": [],
  "schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "protocol": [],
  "configuration_protocol": [],
  "is_csv_upload": 1,
  "csv_data": [],
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T18:21:29.193Z",
  "is_deleted": true,
  "job_iteration_id": "text",
  "last_scan_result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "configuration_download": true,
  "download_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "customer_id": "text",
  "customer_entity_id": "text"
}