{
"openapi":"3.0.0",
"info":{
"version":"2026.04.16",
"title":"REST API for Unified Assurance Microservices",
"description":"The REST API for Oracle Communications Unified Assurance Microservices lets you manage components of Unified Assurance microservice pipelines.",
"x-summary":"The REST API for Oracle Communications Unified Assurance Microservices lets you manage components of Unified Assurance microservice pipelines."
},
"tags":[
{
"name":"Version 1/Discovery (V1)",
"description":"Use to manage discovery."
},
{
"name":"Version 1/Inventory (V1)",
"description":"Use to manage inventory."
},
{
"name":"Version 1/Rediscovery (V1)",
"description":"Use to manage rediscovery."
},
{
"name":"Version 2/Discovery (V2)",
"description":"Use to manage discovery."
},
{
"name":"Version 2/Rediscovery (V2)",
"description":"Use to manage rediscovery."
}
],
"paths":{
"/api/app/discovery/{zoneid}/v2/devices/discover":{
"post":{
"tags":[
"Version 2/Discovery (V2)"
],
"summary":"Create a Discovery Job",
"description":"Creates a new job to discover devices.",
"parameters":[
{
"name":"zoneid",
"in":"path",
"description":"The ID for the zone in which the Discovery Service is deployed.",
"required":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"description":"The discovery request payload (supports V2 format).",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/V2Payload"
},
"examples":{
"V2DiscoveryPayload":{
"$ref":"#/components/examples/V2DiscoveryPayload"
}
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryCreateResponse"
}
}
}
},
"400":{
"description":"Bad request"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"api-app-discovery-{zoneid}-v2-devices-discover-post",
"x-filename-id":"api-app-discovery-zoneid-v2-devices-discover-post"
}
},
"/api/app/discovery/{zoneid}/v2/devices/discoveryStatus":{
"get":{
"tags":[
"Version 2/Discovery (V2)"
],
"summary":"Get Discovery Status",
"description":"Gets the status of a discovery request.",
"parameters":[
{
"name":"zoneid",
"in":"path",
"description":"The ID for the zone in which the Discovery Service is deployed.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryStatusResponse"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"api-app-discovery-{zoneid}-v2-devices-discoveryStatus-get",
"x-filename-id":"api-app-discovery-zoneid-v2-devices-discoverystatus-get"
}
},
"/app/discovery/{zoneid}/v2/devices/discoveryStatus/{discovery-context-id}":{
"get":{
"tags":[
"Version 2/Discovery (V2)"
],
"summary":"Get Discovery Status by ID",
"description":"Gets the status of the discovery request that matches the specified discovery context ID.",
"parameters":[
{
"name":"discovery-context-id",
"in":"path",
"description":"The ID for the discovery request to get status for.",
"required":true,
"schema":{
"type":"string"
}
},
{
"name":"zoneid",
"in":"path",
"description":"The ID for the zone in which the Discovery Service is deployed.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryContextIDStatusResponse"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"app-discovery-{zoneid}-v2-devices-discoveryStatus-{discovery-context-id}-get",
"x-filename-id":"app-discovery-zoneid-v2-devices-discoverystatus-discovery-context-id-get"
}
},
"/api/app/discovery/{zoneid}/v2/devices/discoveryResults/":{
"get":{
"tags":[
"Version 2/Discovery (V2)"
],
"summary":"Get Discovery Results",
"description":"Gets the result of a discovery request.",
"parameters":[
{
"name":"zoneid",
"in":"path",
"description":"The ID for the zone in which the Discovery Service is deployed.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryResultResponse"
}
}
}
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"api-app-discovery-{zoneid}-v2-devices-discoveryResults--get",
"x-filename-id":"api-app-discovery-zoneid-v2-devices-discoveryresults-get"
}
},
"/api/app/discovery/{zoneid}/v2/devices/discoveryResults/{discovery-context-id}":{
"get":{
"tags":[
"Version 2/Discovery (V2)"
],
"summary":"Get Discovery Results by ID",
"description":"Gets the result of the discovery request that matches the specified discovery context ID.",
"parameters":[
{
"name":"zoneid",
"in":"path",
"description":"The ID for the zone in which the Discovery Service is deployed.",
"required":true,
"schema":{
"type":"string"
}
},
{
"in":"path",
"name":"discovery-context-id",
"description":"The ID for the discovery request to get results for.",
"required":true,
"schema":{
"type":"string"
}
},
{
"in":"query",
"name":"discoveredOnly",
"description":"Whether to display only discovered requests (true) or not (false).",
"schema":{
"type":"boolean"
}
},
{
"in":"query",
"name":"withWarnings",
"description":"Whether to enable warnings (true) or not (false).",
"schema":{
"type":"boolean"
}
},
{
"in":"query",
"name":"withErrors",
"description":"Whether to enable errors (true) or not (false).",
"schema":{
"type":"boolean"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/InventoryResponse"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"api-app-discovery-{zoneid}-v2-devices-discoveryResults-{discovery-context-id}-get",
"x-filename-id":"api-app-discovery-zoneid-v2-devices-discoveryresults-discovery-context-id-get"
}
},
"/api/app/discovery/{zoneid}/v2/devices/rediscover":{
"post":{
"tags":[
"Version 2/Rediscovery (V2)"
],
"summary":"Rediscover Devices",
"description":"Rediscovers the devices for the current configuration.",
"parameters":[
{
"name":"zoneid",
"in":"path",
"description":"The ID for the zone in which the Discovery Service is deployed.",
"required":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"description":"The rediscovery payload configuration.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/V2RediscoveryRequest"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryCreateResponse"
}
}
}
},
"401":{
"description":"Unauthorized operation"
},
"405":{
"description":"Bad request"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"api-app-discovery-{zoneid}-v2-devices-rediscover-post",
"x-filename-id":"api-app-discovery-zoneid-v2-devices-rediscover-post"
}
},
"/discovery-service/discovery/request/create":{
"post":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Create a Discovery Job",
"description":"Creates a new job to discover devices. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"requestBody":{
"description":"The discovery request payload.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Payload"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryCreateResponse"
}
}
}
},
"400":{
"description":"Bad request"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-discovery-request-create-post",
"x-filename-id":"discovery-service-discovery-request-create-post"
}
},
"/discovery-service/discovery/request/status/":{
"get":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Get Discovery Status",
"description":"Gets the status of a discovery request. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryStatusResponse"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-discovery-request-status--get",
"x-filename-id":"discovery-service-discovery-request-status-get"
}
},
"/discovery-service/discovery/request/status/{discovery-context-id}":{
"get":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Get Discovery Status by ID",
"description":"Gets the status of the discovery request that matches the specified discovery context ID. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"name":"discovery-context-id",
"in":"path",
"description":"The ID for the discovery request to get status for.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryContextIDStatusResponse"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-discovery-request-status-{discovery-context-id}-get",
"x-filename-id":"discovery-service-discovery-request-status-discovery-context-id-get"
}
},
"/discovery-service/discovery/request/result/":{
"get":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Get Discovery Results",
"description":"Gets the result of a discovery request. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryResultResponse"
}
}
}
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-discovery-request-result--get",
"x-filename-id":"discovery-service-discovery-request-result-get"
}
},
"/discovery-service/discovery/request/result/{discovery-context-id}":{
"get":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Get Discovery Results by ID",
"description":"Gets the result of the discovery request that matches the specified discovery context ID. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"in":"path",
"name":"discovery-context-id",
"description":"The ID for the discovery request to get results for.",
"required":true,
"schema":{
"type":"string"
}
},
{
"in":"query",
"name":"discoveredOnly",
"description":"Whether to display only discovered requests (true) or not (false).",
"schema":{
"type":"boolean"
}
},
{
"in":"query",
"name":"withWarnings",
"description":"Whether to enable warnings (true) or not (false).",
"schema":{
"type":"boolean"
}
},
{
"in":"query",
"name":"withErrors",
"description":"Whether to enable errors (true) or not (false).",
"schema":{
"type":"boolean"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryContextIDResultResponse"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-discovery-request-result-{discovery-context-id}-get",
"x-filename-id":"discovery-service-discovery-request-result-discovery-context-id-get"
}
},
"/discovery-service/discovery/request/result/{discovery-context-id}/profile/{snmp-profile-uuid}":{
"get":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Get Discovery Profile Results by ID",
"description":"Gets the discovery profile results that match the specified context ID and SNMP profile Universal Unique Identifier (UUID). This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"name":"discovery-context-id",
"in":"path",
"description":"The ID for the discovery request.",
"required":true,
"schema":{
"type":"string"
}
},
{
"name":"snmp-profile-uuid",
"in":"path",
"description":"The UUID of the SNMP profile.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomSNMPAccessProfile"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-discovery-request-result-{discovery-context-id}-profile-{snmp-profile-uuid}-get",
"x-filename-id":"discovery-service-discovery-request-result-discovery-context-id-profile-snmp-profile-uuid-get"
}
},
"/discovery-service/discovery/request/result/{discovery-context-id}/profile/":{
"get":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Get SNMP Profile Results",
"description":"Gets the SNMP profile result for the specified discovery context ID. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"name":"discovery-context-id",
"in":"path",
"description":"The ID for the discovery request.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryContextIDProfiles"
}
}
}
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-discovery-request-result-{discovery-context-id}-profile--get",
"x-filename-id":"discovery-service-discovery-request-result-discovery-context-id-profile-get"
},
"post":{
"tags":[
"Version 1/Discovery (V1)"
],
"summary":"Add an SNMP Profile to a Discovery Job",
"description":"Adds an SNMP profile to the discovery job that matches the specified discovery context ID. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"name":"discovery-context-id",
"in":"path",
"description":"The ID of the discovery request to add the SNMP profile to.",
"required":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"description":"The custom SNMP access profile configuration to add to the discovery job.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomSNMPAccessProfile"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"text/plain":{
"schema":{
"type":"string"
}
}
}
},
"400":{
"description":"Bad request"
},
"401":{
"description":"Unauthorized operation"
}
},
"x-internal-id":"discovery-service-discovery-request-result-{discovery-context-id}-profile--post",
"x-filename-id":"discovery-service-discovery-request-result-discovery-context-id-profile-post"
}
},
"/discovery-service/inventory":{
"post":{
"tags":[
"Version 1/Inventory (V1)"
],
"summary":"Add Discovery Results to the Inventory",
"description":"Adds the discovery results to the inventory. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"in":"query",
"name":"PublishErrors",
"description":"Whether to publish errors (true) or not (false).",
"schema":{
"type":"boolean"
}
}
],
"requestBody":{
"description":"The inventory payload configuration.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/InventoryResponse"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"type":"object"
}
}
}
},
"400":{
"description":"Bad Request"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-inventory-post",
"x-filename-id":"discovery-service-inventory-post"
},
"patch":{
"tags":[
"Version 1/Inventory (V1)"
],
"summary":"Update the Inventory",
"description":"Updates the inventory with the discovery results. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"in":"query",
"name":"PublishErrors",
"description":"Whether to publish errors (true) or not (false).",
"schema":{
"type":"boolean"
}
},
{
"in":"query",
"name":"PruneInstances",
"description":"Whether to prune instances (true) or not (false). If set to true, any instances that are not present in the payload and belongs to the device are deleted.",
"schema":{
"type":"boolean"
}
}
],
"requestBody":{
"description":"The inventory payload configuration.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/InventoryResponse"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"type":"object"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"405":{
"description":"Bad request"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-inventory-patch",
"x-filename-id":"discovery-service-inventory-patch"
},
"put":{
"tags":[
"Version 1/Inventory (V1)"
],
"summary":"Replace the Inventory",
"description":"Replaces all of a device's interfaces in the inventory with the new interfaces specified in the request. Interfaces under the specified device that appear in the request but not present in the database are added to the database. Interfaces under the specified device that appear in the database but not in the request are removed from the database.
Any devices in the inventory not included in the request are left unchanged. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"parameters":[
{
"in":"query",
"name":"PublishErrors",
"description":"Whether to publish errors (true) or not (false).",
"schema":{
"type":"boolean"
}
}
],
"requestBody":{
"description":"The inventory payload configuration.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/InventoryResponse"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"type":"object"
}
}
}
},
"204":{
"description":"No content"
},
"401":{
"description":"Unauthorized operation"
},
"405":{
"description":"Bad request"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-inventory-put",
"x-filename-id":"discovery-service-inventory-put"
}
},
"/discovery-service/inventory/translate/":{
"post":{
"tags":[
"Version 1/Inventory (V1)"
],
"summary":"Translate the Inventory Status",
"description":"Converts the discovery results by adding default values. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"requestBody":{
"description":"The inventory payload configuration.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryContextIDResultResponse"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/InventoryResponse"
}
}
}
},
"400":{
"description":"Bad request"
},
"401":{
"description":"Unauthorized operation"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-inventory-translate--post",
"x-filename-id":"discovery-service-inventory-translate-post"
}
},
"/discovery-service/rediscovery":{
"post":{
"tags":[
"Version 1/Rediscovery (V1)"
],
"summary":"Rediscover Devices",
"description":"Rediscovers the devices for the current configuration. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.",
"requestBody":{
"description":"The rediscovery payload configuration.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RediscoveryRequest"
}
}
}
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DiscoveryCreateResponse"
}
}
}
},
"401":{
"description":"Unauthorized operation"
},
"405":{
"description":"Bad request"
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"discovery-service-rediscovery-post",
"x-filename-id":"discovery-service-rediscovery-post"
}
}
},
"components":{
"examples":{
"V2DiscoveryPayload":{
"summary":"V2 discovery request payload example",
"value":{
"Type":"discovery",
"Version":"2.0.0",
"Data":{
"Configuration":{
"ForcedProtocolDiscovery":true,
"ContextExpiryTimeM":60,
"ICMPConfiguration":[
{
"Mode":1,
"Timeouts":10,
"Count":5,
"CascadeMs":5,
"COMType":"ACOM"
}
],
"SNMPConfiguration":[
{
"Method":"BULK",
"ProbeV2Support":false,
"NetworkOptions":{
"Timeout":"5s",
"ExponentialTimeout":false,
"Retries":3,
"MaxOids":100,
"MaxRepetitions":50,
"NonRepeaters":1
},
"CustomSNMPAccessProfile":{
"Version":2,
"ProfileID":1,
"UUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Priority":1,
"Port":161,
"MTU":1456,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80001adc802417e202b8613f5400000000"
}
},
"IPAddress":"192.0.2.10",
"IPRange":"192.0.2.0/24",
"COMType":"ACOM"
}
],
"RESTConfiguration":[
{
"Url":"192.0.2.0",
"Protocol":"https",
"Port":8080,
"APIAccessID":"dGVzdA==",
"APIAccessKey":"dGVzdA==",
"APIType":"vmware"
}
],
"GNMIConfiguration":[
{
"Mode":"insecure",
"Username":"YWRtaW4=",
"Password":"cGFzc3dvcmQ=",
"Port":50051
}
]
},
"IPRanges":[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
],
"IPList":[
"203.0.113.0",
"203.0.113.1"
],
"ExcludedIPList":[
"192.0.2.6"
],
"Level":[
1,
2,
3,
4
],
"InventoryEngine":"inventory-engine-name",
"TenantID":1,
"DiscoveryJobID":1,
"autoMonitor":false
}
}
},
"LegacyDiscoveryPayload":{
"summary":"Legacy discovery request payload example",
"value":{
"Type":"discovery",
"Version":"1.0.0",
"Data":{
"Configuration":{
"ForcedProtocolDiscovery":true,
"ContextExpiryTimeM":60,
"ICMPConfiguration":[
{
"Mode":1,
"Timeouts":10,
"Count":5,
"CascadeMs":5
}
],
"SNMPConfiguration":[
{
"Method":"BULK",
"IsTCP":false,
"NetworkOptions":{
"Timeout":"5s",
"ExponentialTimeout":false,
"Retries":3,
"MaxOids":100,
"MaxRepetitions":50,
"NonRepeaters":1
},
"CustomSNMPAccessProfiles":[
{
"Version":2,
"ProfileID":1,
"UUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Priority":1,
"Port":161,
"MTU":1456,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80001adc802417e202b8613f5400000000"
}
}
]
}
],
"RESTConfiguration":[
{
"Url":"192.0.2.0",
"Protocol":"https",
"Port":8080,
"APIAccessID":"dGVzdA==",
"APIAccessKey":"dGVzdA==",
"APIType":"vmware"
}
],
"GNMIConfiguration":[
{
"Mode":"insecure",
"Username":"YWRtaW4=",
"Password":"cGFzc3dvcmQ=",
"Port":50051
}
]
},
"IPranges":[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
],
"IPList":[
"203.0.113.0",
"203.0.113.1"
],
"Level":[
1,
2,
3,
4
],
"InventoryEngine":"inventory-engine-name",
"TenantID":1
}
}
}
},
"schemas":{
"V2Payload":{
"type":"object",
"description":"The payload for a discovery request.",
"properties":{
"Type":{
"description":"The type of discovery.",
"type":"string",
"enum":[
"discovery"
]
},
"Version":{
"description":"The discovery version.",
"type":"string",
"example":"2.0.0"
},
"Data":{
"description":"The discovery request data.",
"type":"object",
"properties":{
"Configuration":{
"description":"The ICMP, SNMP and REST Configuration for discovery.",
"type":"object",
"properties":{
"ForcedProtocolDiscovery":{
"description":"Whether to discover every protocol regardless of ICMP result (true) or not (false).",
"type":"boolean",
"enum":[
true,
false
]
},
"ContextExpiryTimeM":{
"description":"The number of minutes before the discovery expires.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":60
},
"ICMPConfiguration":{
"description":"The list of ICMP configurations.",
"type":"array",
"items":{
"$ref":"#/components/schemas/V2ICMPConfiguration"
}
},
"SNMPConfiguration":{
"description":"The list of SNMP configurations.",
"type":"array",
"items":{
"$ref":"#/components/schemas/V2SNMPConfiguration"
}
},
"RESTConfiguration":{
"description":"The list of REST configurations.",
"type":"array",
"items":{
"$ref":"#/components/schemas/RESTConfiguration"
}
},
"GNMIConfiguration":{
"description":"The list of gNMI configurations.",
"type":"array",
"items":{
"$ref":"#/components/schemas/GNMIConfiguration"
}
}
}
},
"IPRanges":{
"description":"List of IP Ranges. Supports CIDR ranges.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
]
},
"IPList":{
"description":"List of IP Addresses.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"203.0.113.0",
"203.0.113.1"
]
},
"ExcludedIPList":{
"description":"List of IP Addresses to exclude.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"192.0.2.6"
]
},
"Level":{
"description":"Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.",
"type":"array",
"items":{
"type":"integer",
"enum":[
1,
2,
3
]
},
"example":[
1,
2,
3
]
},
"InventoryEngine":{
"description":"Discovery inventory engine name.",
"type":"string",
"example":"inventory-engine-name"
},
"TenantID":{
"description":"Discovery for TenantID. Optional.",
"type":"integer",
"example":1
},
"DiscoveryJobID":{
"description":"Run Discovery Associated to a Discovery Job ID. Optional.",
"type":"integer",
"example":1
},
"autoMonitor":{
"description":"Set this to complete discovery automatically.",
"type":"boolean",
"example":false
}
}
}
}
},
"Payload":{
"type":"object",
"description":"The payload for a discovery request.",
"properties":{
"Type":{
"description":"The type of discovery.",
"type":"string",
"enum":[
"discovery"
]
},
"Version":{
"description":"The discovery version.",
"type":"string",
"example":"1.0.0"
},
"Data":{
"description":"The discovery request data.",
"type":"object",
"properties":{
"Configuration":{
"description":"The ICMP, SNMP and REST Configuration for discovery.",
"type":"object",
"properties":{
"ForcedProtocolDiscovery":{
"description":"Whether to discover every protocol regardless of ICMP result (true) or not (false).",
"type":"boolean",
"enum":[
true,
false
]
},
"ContextExpiryTimeM":{
"description":"The number of minutes before the discovery expires.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":60
},
"ICMPConfiguration":{
"description":"The list of ICMP configurations.",
"type":"array",
"items":{
"$ref":"#/components/schemas/ICMPConfiguration"
}
},
"SNMPConfiguration":{
"description":"The list of SNMP configurations.",
"type":"array",
"items":{
"$ref":"#/components/schemas/SNMPConfiguration"
}
},
"RESTConfiguration":{
"description":"The list of REST configurations.",
"type":"array",
"items":{
"$ref":"#/components/schemas/RESTConfiguration"
}
}
}
},
"IPranges":{
"description":"List of IP Ranges. Supports CIDR ranges.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
]
},
"IPList":{
"description":"List of IP Addresses.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"203.0.113.0",
"203.0.113.1"
]
},
"Level":{
"description":"Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.",
"type":"array",
"items":{
"type":"integer",
"enum":[
1,
2,
3
]
},
"example":[
1,
2,
3
]
},
"InventoryEngine":{
"description":"Discovery inventory engine name.",
"type":"string",
"example":"inventory-engine-name"
},
"TenantID":{
"description":"Discovery for TenantID. Optional.",
"type":"integer",
"example":1
}
}
}
}
},
"V2ICMPConfiguration":{
"description":"The ICMP payload configuration.",
"type":"object",
"required":[
"Mode"
],
"properties":{
"Mode":{
"description":"The ICMP mode. Possible values are 0 for synchronous and 1 for asynchronous.",
"type":"integer",
"enum":[
0,
1
],
"example":1
},
"Timeouts":{
"description":"The number of milliseconds to wait for the ping message corresponding to a given ping.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":10
},
"Count":{
"description":"The number of ping requests to send.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":5
},
"CascadeMs":{
"description":"The number of milliseconds between two successful pings.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":5
},
"COMType":{
"description":"Type of ICMP Discovery. Can be ICMP Availability, ICMP Performance, or both.",
"type":"string",
"enum":[
"ACOM",
"PCOM",
"ACOM_PCOM"
],
"example":"ACOM"
}
}
},
"ICMPConfiguration":{
"description":"The ICMP payload configuration.",
"type":"object",
"required":[
"Mode"
],
"properties":{
"Mode":{
"description":"The ICMP mode. Possible values are 0 for synchronous and 1 for asynchronous.",
"type":"integer",
"enum":[
0,
1
],
"example":1
},
"Timeouts":{
"description":"The number of milliseconds to wait for the ping message corresponding to a given ping message.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":10
},
"Count":{
"description":"The number of ping requests to send.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":5
},
"CascadeMs":{
"description":"The number of milliseconds between two successful pings.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":5
}
}
},
"SNMPConfiguration":{
"description":"The SNMP payload configuration.",
"type":"object",
"properties":{
"Method":{
"description":"The SNMP method.",
"type":"string",
"enum":[
"BULK",
"GET"
],
"example":"BULK"
},
"IsTCP":{
"description":"Whether SNMP is implemented over TCP (true) or not (false).",
"type":"boolean",
"enum":[
true,
false
],
"example":false
},
"NetworkOptions":{
"$ref":"#/components/schemas/NetworkOptions"
},
"CustomSNMPAccessProfiles":{
"description":"The list of custom SNMP access profiles.",
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomSNMPAccessProfile"
}
}
}
},
"V2SNMPConfiguration":{
"description":"The V2 SNMP payload configuration.",
"type":"object",
"properties":{
"Method":{
"description":"The SNMP method.",
"type":"string",
"enum":[
"BULK",
"GET"
],
"example":"BULK"
},
"ProbeV2Support":{
"description":"Whether probe v2 support is enabled.",
"type":"boolean",
"example":false
},
"NetworkOptions":{
"$ref":"#/components/schemas/NetworkOptions"
},
"CustomSNMPAccessProfile":{
"$ref":"#/components/schemas/CustomSNMPAccessProfile"
},
"IPAddress":{
"description":"The IP address for discovery.",
"type":"string",
"example":"192.0.2.10"
},
"IPRange":{
"description":"The IP range for discovery.",
"type":"string",
"example":"192.0.2.0/24"
},
"COMType":{
"description":"Type of SNMP Discovery. Can be SNMP Availability, SNMP Performance, or both.",
"type":"string",
"enum":[
"ACOM",
"PCOM",
"ACOM_PCOM"
],
"example":"ACOM"
}
}
},
"NetworkOptions":{
"description":"Network options for SNMP communication.",
"type":"object",
"properties":{
"Timeout":{
"description":"The number of seconds, minutes, hours, or days before the request times out.",
"type":"string",
"enum":[
"1s",
"2m",
"3h",
"4d"
],
"example":"5s"
},
"ExponentialTimeout":{
"description":"The status is enabled to timeout exponentially if the request fails.",
"type":"boolean",
"enum":[
true,
false
],
"example":false
},
"Retries":{
"description":"The number of times to retry the request.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":3
},
"MaxOids":{
"description":"The maximum SNMP OID value.",
"type":"integer",
"minimum":0,
"maximum":128,
"example":100
},
"MaxRepetitions":{
"description":"The maximum number of repetitions.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":50
},
"NonRepeaters":{
"description":"The number of non repeaters.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":1
}
}
},
"CustomSNMPAccessProfile":{
"description":"A custom SNMP access profile.",
"type":"object",
"required":[
"Version"
],
"properties":{
"Version":{
"description":"The custom SNMP access profile version.",
"type":"integer",
"enum":[
1,
2,
3
],
"example":2
},
"ProfileID":{
"description":"The custom SNMP access profile ID.",
"type":"integer",
"minimum":0,
"maximum":"4294967295",
"example":1
},
"UUID":{
"description":"The custom SNMP access profile UUID.",
"type":"string",
"format":"uuid",
"example":"df29b366-c3a4-4a89-8ec8-2f1527276c75"
},
"Priority":{
"description":"The custom SNMP access profile priority.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":1
},
"Port":{
"description":"The custom SNMP access profile port.",
"type":"integer",
"minimum":0,
"maximum":65535,
"example":161
},
"MTU":{
"description":"The MTU for the custom SNMP access profile.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":1456
},
"Auth":{
"$ref":"#/components/schemas/CustomSNMPAccessProfileAuth"
}
}
},
"CustomSNMPAccessProfileAuth":{
"description":"Custom SNMP access profile authentication information.",
"type":"object",
"properties":{
"Community":{
"description":"The custom SNMP access profile community string.",
"type":"string",
"example":"public"
},
"Username":{
"description":"The custom SNMP access profile user name.",
"type":"string",
"example":"user"
},
"AuthType":{
"description":"The custom SNMP access profile authentication type.",
"type":"string",
"enum":[
"NOAUTHNOPRIV",
"AUTHNOPRIV",
"AUTHPRIV"
],
"example":"AUTHPRIV"
},
"AuthPassphrase":{
"description":"The custom SNMP access profile authentication passphrase.",
"type":"string",
"example":"QXV0aFBhc3N3b3Jk"
},
"AuthProtocol":{
"description":"The custom SNMP access profile authentication protocol.",
"type":"string",
"example":"SHA256"
},
"PrivPassphrase":{
"description":"The custom SNMP access profile private passphrase.",
"type":"string",
"example":"UHJpdlBhc3N3b3Jk"
},
"PrivProtocol":{
"description":"The custom SNMP access profile private protocol.",
"type":"string",
"example":"AES"
},
"AuthEngineID":{
"description":"The custom SNMP access profile authentication engine ID.",
"type":"string",
"example":"80001adc802417e202b8613f5400000000"
}
}
},
"RESTConfiguration":{
"description":"REST configurations for Cisco Meraki, Juniper MIST and VMWare connections.",
"type":"object",
"required":[
"Protocol",
"APIType"
],
"properties":{
"Url":{
"description":"The REST API URL for Meraki, VMWare or Mist.",
"type":"string",
"example":"192.0.2.0"
},
"Protocol":{
"description":"The protocol used for the REST API.",
"type":"string",
"enum":[
"http",
"https"
],
"example":"https"
},
"Port":{
"description":"The port number for the REST API URL.",
"type":"integer",
"minimum":0,
"maximum":65535,
"example":8080
},
"APIAccessID":{
"description":"The base64-encoded API access ID for the REST API URL.",
"type":"string",
"example":"dGVzdA=="
},
"APIAccessKey":{
"description":"The base64-encoded API access key for the REST API URL.",
"type":"string",
"example":"ZXhhbXBsZQ=="
},
"APIType":{
"description":"The REST API type.",
"type":"string",
"enum":[
"vmware"
],
"example":"vmware"
}
}
},
"GNMIConfiguration":{
"description":"Configurations for gNMI collectors.",
"type":"object",
"properties":{
"Mode":{
"description":"Mode used to connect.",
"type":"string",
"enum":[
"insecure",
"secure"
],
"example":"insecure"
},
"Username":{
"description":"The base64-encoded username used to connect.",
"type":"string",
"example":"YWRtaW4="
},
"Port":{
"description":"The port number for the REST API URL.",
"type":"integer",
"minimum":0,
"maximum":65535,
"example":50051
},
"Password":{
"description":"The base64-encoded password to connect.",
"type":"string",
"example":"dGVzdA=="
}
}
},
"DiscoveryCreateResponse":{
"type":"object",
"properties":{
"DiscoveryContextID":{
"description":"The ID obtained from discovery request.",
"type":"string",
"example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
},
"time-valid":{
"description":"The number of seconds the discovery result is valid.",
"type":"integer",
"example":3600
}
}
},
"DiscoveryStatusResponse":{
"description":"The status of all discovery requests.",
"type":"object",
"additionalProperties":{
"$ref":"#/components/schemas/DiscoveryContextIDStatusResponse"
},
"example":{
"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7":{
"DiscoveryContextID":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7",
"RequestedLevel":[
1,
2,
3
],
"TimestampInitiated":1702215346,
"ICMPStatus":"Completed",
"ICMPProgress":6,
"ICMPTotal":6,
"SNMPStatus":"Completed",
"SNMPProgress":6,
"SNMPTotal":6,
"APIStatus":"Completed",
"APIProgress":6,
"APITotal":6
},
"disco-490fda03-dea8-43bd-89f1-9117fb962442":{
"DiscoveryContextID":"disco-490fda03-dea8-43bd-89f1-9117fb962442",
"RequestedLevel":[
1,
2,
3
],
"TimestampInitiated":1702216489,
"ICMPStatus":"Completed",
"ICMPProgress":2,
"ICMPTotal":2,
"SNMPStatus":"Completed",
"SNMPProgress":2,
"SNMPTotal":2,
"APIStatus":"Completed",
"APIProgress":2,
"APITotal":2
}
}
},
"DiscoveryContextIDStatusResponse":{
"description":"The status of a discovery request.",
"type":"object",
"properties":{
"DiscoveryContextID":{
"description":"The discovery request ID.",
"type":"string",
"example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
},
"RequestedLevel":{
"description":"The types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.",
"type":"array",
"items":{
"type":"integer"
},
"enum":[
1,
2,
3
],
"example":[
1,
2,
3
]
},
"TimestampInitiated":{
"description":"The Unix time in seconds when discovery was initiated.",
"type":"integer",
"minimum":0,
"maximum":"9223372036854776000",
"example":1702215346
},
"ICMPStatus":{
"description":"The ICMP discovery status.",
"type":"string",
"enum":[
"In Progress",
"Completed",
"NA"
],
"example":"Completed"
},
"ICMPProgress":{
"description":"The number of ICMP jobs completed for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
},
"ICMPTotal":{
"description":"The number of ICMP jobs requested for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
},
"SNMPStatus":{
"description":"The SNMP discovery status.",
"type":"string",
"enum":[
"In Progress",
"Completed",
"NA"
],
"example":"Completed"
},
"SNMPProgress":{
"description":"The number of SNMP jobs completed for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
},
"SNMPTotal":{
"description":"The number of SNMP jobs requested for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
},
"APIStatus":{
"description":"The REST API discovery status.",
"type":"string",
"enum":[
"In Progress",
"Completed",
"NA"
],
"example":"Completed"
},
"APIProgress":{
"description":"The number of REST API jobs completed for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
},
"APITotal":{
"description":"The number of REST API jobs requested for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
},
"GNMIStatus":{
"description":"The gNMI discovery status.",
"type":"string",
"enum":[
"In Progress",
"Completed",
"NA"
],
"example":"Completed"
},
"GNMIProgress":{
"description":"The number of gNMI jobs completed for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
},
"GNMITotal":{
"description":"The number of gNMI jobs requested for the discovery.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":6
}
}
},
"DiscoveryResultResponse":{
"type":"object",
"description":"The discovery request results.",
"properties":{
"DiscoveryContexts":{
"type":"array",
"items":{
"properties":{
"DiscoveryContextID":{
"description":"The discovery request ID.",
"type":"string",
"example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
},
"TimestampInitiated":{
"description":"The Unix time in seconds when the discovery was initiated.",
"type":"integer",
"minimum":0,
"maximum":"9223372036854776000",
"example":1702214858
},
"TimeValidS":{
"description":"The number of seconds that the discovery is valid.",
"type":"integer",
"minimum":0,
"maximum":"9223372036854776000",
"example":1216
},
"TimestampExpiration":{
"description":"The Unix time in seconds when the discovery expired.",
"type":"integer",
"minimum":0,
"maximum":"9223372036854776000",
"example":1702214858
},
"InventoryHandler":{
"description":"The inventory handler name.",
"type":"string",
"example":"inventory-engine-name"
},
"Request":{
"description":"The configuration provided for discovery.",
"type":"object",
"properties":{
"Configuration":{
"description":"The ICMP, SNMP and REST configurations for discovery.",
"type":"object",
"properties":{
"ForcedProtocolDiscovery":{
"description":"Whether to enable every discovery protocol, regardless of ICMP results (true) or not (false).",
"type":"boolean",
"enum":[
true,
false
]
},
"ContextExpiryTimeM":{
"description":"The number of minutes the discovery is valid before expiring.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":60
},
"ICMPConfiguration":{
"type":"array",
"description":"The ICMP configuration for discovery.",
"items":{
"$ref":"#/components/schemas/ICMPConfiguration"
}
},
"SNMPConfiguration":{
"type":"array",
"description":"The SNMP configuration for discovery.",
"items":{
"$ref":"#/components/schemas/SNMPConfiguration"
}
},
"RESTConfiguration":{
"type":"array",
"description":"The REST configuration for discovery.",
"items":{
"$ref":"#/components/schemas/RESTConfiguration"
}
}
}
},
"IPranges":{
"description":"The list of IP ranges to perform discovery on. Supports CIDR ranges.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
]
},
"IPList":{
"description":"The list of IP addresses to perform discovery on.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"203.0.113.0",
"203.0.113.1"
]
},
"Level":{
"description":"The types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.",
"type":"array",
"items":{
"type":"integer",
"enum":[
1,
2,
3
],
"example":[
1,
2,
3
]
}
},
"InventoryEngine":{
"description":"The inventory engine name.",
"type":"string",
"example":"inventory-engine-name"
}
}
},
"ExecutionConfiguration":{
"type":"object",
"description":"The configuration for running discovery.",
"properties":{
"ForcedProtocolDiscovery":{
"description":"Whether to enable every discovery protocol, regardless of ICMP results (true) or not (false).",
"type":"boolean",
"enum":[
true,
false
]
},
"ContextExpiryTimeM":{
"description":"The number of minutes the discovery is valid before expiring.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":60
},
"ICMPConfiguration":{
"type":"array",
"description":"The ICMP configuration for discovery.",
"items":{
"$ref":"#/components/schemas/ICMPConfiguration"
}
},
"SNMPConfiguration":{
"type":"array",
"description":"The SNMP configuration for discovery.",
"items":{
"$ref":"#/components/schemas/SNMPConfiguration"
}
},
"RESTConfiguration":{
"type":"array",
"description":"The REST configuration for discovery.",
"items":{
"$ref":"#/components/schemas/RESTConfiguration"
}
}
}
}
}
}
}
},
"example":{
"DiscoveryContexts":[
{
"DiscoveryContextID":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7",
"TimestampInitiated":1702214858,
"TimeValidS":1216,
"TimestampExpiration":1702214858,
"InventoryHandler":"inventory-engine-name",
"Request":{
"Configuration":{
"ForcedProtocolDiscovery":true,
"ContextExpiryTimeM":60,
"ICMPConfiguration":[
{
"Mode":1,
"Timeouts":10,
"Count":5,
"CascadeMs":5
}
],
"SNMPConfiguration":[
{
"Method":"BULK",
"IsTCP":false,
"NetworkOptions":{
"Timeout":"5s",
"ExponentialTimeout":false,
"Retries":3,
"MaxOids":100,
"MaxRepetitions":50,
"NonRepeaters":1
},
"CustomSNMPAccessProfiles":[
{
"Version":2,
"ProfileID":1,
"UUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Priority":1,
"Port":161,
"MTU":1456,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80001adc802417e202b8613f5400000000"
}
}
]
}
],
"RESTConfiguration":[
{
"Url":"192.0.2.0",
"Protocol":"https",
"Port":8080,
"APIAccessID":"dGVzdA==",
"APIAccessKey":"dGVzdA==",
"APIType":"vmware"
}
]
},
"IPranges":[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
],
"IPList":[
"203.0.113.0",
"203.0.113.1"
],
"Level":[
[
1,
2,
3
]
],
"InventoryEngine":"inventory-engine-name"
},
"ExecutionConfiguration":{
"ForcedProtocolDiscovery":true,
"ContextExpiryTimeM":60,
"ICMPConfiguration":[
{
"Mode":1,
"Timeouts":10,
"Count":5,
"CascadeMs":5
}
],
"SNMPConfiguration":[
{
"Method":"BULK",
"IsTCP":false,
"NetworkOptions":{
"Timeout":"5s",
"ExponentialTimeout":false,
"Retries":3,
"MaxOids":100,
"MaxRepetitions":50,
"NonRepeaters":1
},
"CustomSNMPAccessProfiles":[
{
"Version":2,
"ProfileID":1,
"UUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Priority":1,
"Port":161,
"MTU":1456,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80001adc802417e202b8613f5400000000"
}
}
]
}
],
"RESTConfiguration":[
{
"Url":"192.0.2.0",
"Protocol":"https",
"Port":8080,
"APIAccessID":"dGVzdA==",
"APIAccessKey":"dGVzdA==",
"APIType":"vmware"
}
]
}
},
{
"DiscoveryContextID":"disco-9794ffd7-0cb3-4f90-a17f-be527c46753d",
"TimestampInitiated":1702214858,
"TimeValidS":3587,
"TimestampExpiration":1702214858,
"InventoryHandler":"inventory-engine-name",
"Request":{
"Configuration":{
"ForcedProtocolDiscovery":true,
"ContextExpiryTimeM":60,
"ICMPConfiguration":[
{
"Mode":0,
"Timeouts":3,
"Count":10,
"CascadeMs":10
}
],
"SNMPConfiguration":[
{
"Method":"BULK",
"IsTCP":false,
"NetworkOptions":{
"Timeout":"10s",
"ExponentialTimeout":false,
"Retries":3,
"MaxOids":100,
"MaxRepetitions":50,
"NonRepeaters":1
},
"CustomSNMPAccessProfiles":[
{
"Version":2,
"ProfileID":1,
"UUID":"ef29b365-d3a3-5a88-9ec7-3f1527276c74",
"Priority":1,
"Port":161,
"MTU":1456,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80002adc802417e202b8613f5400000000"
}
}
]
}
],
"RESTConfiguration":[
{
"Url":"192.0.2.0",
"Protocol":"https",
"Port":8081,
"APIAccessID":"dGVzdA==",
"APIAccessKey":"dGVzdA==",
"APIType":"vmware"
}
]
},
"IPranges":[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
],
"IPList":[
"203.0.113.0",
"203.0.113.1"
],
"Level":[
[
1,
2,
3
]
],
"InventoryEngine":"inventory-engine-name"
},
"ExecutionConfiguration":{
"ForcedProtocolDiscovery":true,
"ContextExpiryTimeM":60,
"ICMPConfiguration":[
{
"Mode":1,
"Timeouts":10,
"Count":5,
"CascadeMs":5
}
],
"SNMPConfiguration":[
{
"Method":"BULK",
"IsTCP":false,
"NetworkOptions":{
"Timeout":"10s",
"ExponentialTimeout":false,
"Retries":3,
"MaxOids":100,
"MaxRepetitions":50,
"NonRepeaters":1
},
"CustomSNMPAccessProfiles":[
{
"Version":2,
"ProfileID":1,
"UUID":"ef29b365-d3a3-5a88-9ec7-3f1527276c74",
"Priority":1,
"Port":161,
"MTU":1456,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80002adc802417e202b8613f5400000000"
}
}
]
}
],
"RESTConfiguration":[
{
"Url":"192.0.2.0",
"Protocol":"https",
"Port":8081,
"APIAccessID":"dGVzdA==",
"APIAccessKey":"dGVzdA==",
"APIType":"vmware"
}
]
}
}
]
}
},
"DiscoveryContextIDResultResponse":{
"type":"object",
"description":"The discovery result containing the discovery context id.",
"properties":{
"Model":{
"description":"The discovery model name.",
"type":"string",
"example":"discovery"
},
"Type":{
"description":"The discovery type.",
"type":"string",
"example":"ping"
},
"Version":{
"description":"The discovery version.",
"type":"string",
"example":"0.0.1"
},
"DiscoveryContextID":{
"description":"The ID obtained from discovery request.",
"type":"string",
"example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
},
"ModelData":{
"type":"object",
"description":"The discovery result data.",
"properties":{
"Devices":{
"description":"The list of the devices discovered.",
"type":"object",
"additionalProperties":{
"properties":{
"ICMPData":{
"description":"The ICMP data discovered for the discovery.",
"type":"object",
"properties":{
"Available":{
"description":"The availability state of the device.",
"type":"boolean",
"enum":[
true,
false
]
},
"Hostname":{
"description":"The hostname of the device.",
"type":"string"
},
"LastRTTNano":{
"description":"The round trip time in nanoseconds.",
"type":"integer"
},
"Timestamp":{
"description":"The Unix time in seconds at which icmp data is discovered.",
"type":"integer",
"example":2147483647
},
"WorkerError":{
"description":"The status of the ping poller worker error.",
"type":"boolean",
"enum":[
true,
false
]
},
"WorkerErrorMessage":{
"description":"The worker error message obtained from the ping poller when discovery is done.",
"type":"string",
"example":"ICMP configuration failed"
},
"IPAddress":{
"description":"The IP address of the device.",
"type":"string"
},
"ZoneID":{
"description":"The zone ID of the device.",
"type":"integer"
}
}
},
"SNMPData":{
"description":"The SNMP data discovered for the discovery.",
"type":"object",
"properties":{
"Target":{
"description":"The hostname or IP address of the device.",
"type":"string"
},
"ProfileUUID":{
"description":"The SNMP profile UUID of the device.",
"type":"string"
},
"ProfileID":{
"description":"The SNMP profile ID of the device.",
"type":"integer"
},
"Discovered":{
"description":"The discovery status of the SNMP device.",
"type":"boolean",
"enum":[
true,
false
]
},
"AuthEngineID":{
"description":"The SNMP profile authentication engine ID.",
"type":"string"
},
"DeviceSystemInfo":{
"description":"Information about the SNMP device system.",
"type":"object",
"properties":{
"SerialNumber":{
"description":"The serial number of the SNMP device.",
"type":"string"
},
"SysContact":{
"description":"The primary contact of the SNMP device.",
"type":"string"
},
"SysDescription":{
"description":"The description of the SNMP device.",
"type":"string"
},
"SysLocation":{
"description":"The physical location of the SNMP device being monitored.",
"type":"string"
},
"SysName":{
"description":"The administratively assigned name for the SNMP device.",
"type":"string"
},
"SysOid":{
"description":"The object identifier of the SNMP device.",
"type":"string"
}
}
},
"Performance":{
"description":"The performance data of the SNMP device.",
"type":"array",
"items":{
"type":"object",
"properties":{
"Vendor":{
"description":"The name of the vendor to which the SNMP device belongs.",
"type":"string"
},
"Class":{
"description":"The name of the class to which the SNMP device belongs.",
"type":"string"
},
"SubClass":{
"description":"The name of the sub class to which the SNMP device belongs.",
"type":"string"
},
"Weight":{
"description":"The importance level for the SNMP device.",
"type":"integer"
},
"ObjectName":{
"description":"The object name of the SNMP device.",
"type":"string"
},
"Discovered":{
"description":"The discovery status of the SNMP device.",
"type":"boolean",
"enum":[
true,
false
]
}
}
}
},
"Availability":{
"description":"The availability data of the SNMP device.",
"type":"array",
"items":{
"type":"object",
"properties":{
"Vendor":{
"description":"The name of the vendor to which the SNMP device belongs.",
"type":"string"
},
"Class":{
"description":"The name of the class to which the SNMP device belongs.",
"type":"string"
},
"SubClass":{
"description":"The name of the sub class to which the SNMP device belongs.",
"type":"string"
},
"Weight":{
"description":"The importance level for the SNMP device.",
"type":"integer"
},
"ObjectName":{
"description":"The object name of the SNMP device.",
"type":"string"
},
"Discovered":{
"description":"The discovery status of the SNMP device.",
"type":"boolean",
"enum":[
true,
false
]
},
"InstanceOid":{
"description":"The instance object identifier of the SNMP device.",
"type":"string"
},
"Instances":{
"description":"Details of the SNMP device instances.",
"type":"array"
}
}
}
},
"WorkerError":{
"description":"The status of the SNMP poller worker error.",
"type":"boolean",
"enum":[
true,
false
]
},
"WorkerErrorMessage":{
"description":"The worker error message obtained from the SNMP poller when discovery is completed.",
"type":"string"
}
}
}
}
},
"example":{
"203.0.113.0":{
"ICMPData":{
"Available":true,
"Hostname":"example1.oracle.com",
"LastRTTNano":221198,
"Timestamp":1702216942,
"IPAddress":"203.0.113.0",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"203.0.113.1":{
"ICMPData":{
"Available":true,
"Hostname":"example2.oracle.com",
"LastRTTNano":645484,
"Timestamp":1702216942,
"IPAddress":"203.0.113.1",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"192.0.2.0":{
"ICMPData":{
"Available":true,
"Hostname":"example3.oracle.com",
"LastRTTNano":688044,
"Timestamp":1702216942,
"IPAddress":"192.0.2.0",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.0",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example3.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.4"
}
}
},
"192.0.2.1":{
"ICMPData":{
"Available":true,
"Hostname":"example4.oracle.com",
"LastRTTNano":1491998,
"Timestamp":1702216942,
"IPAddress":"192.0.2.1",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.1",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example4.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.3"
}
}
}
}
},
"VMWare":{
"description":"The VMware data discovered for the discovery.",
"type":"array",
"items":{
"type":"object",
"properties":{
"TargetURL":{
"description":"The REST API URL of the VMware instance.",
"type":"string",
"example":"https://192.0.2.0:8080"
},
"IPAddress":{
"description":"The REST API IP address of the VMware instance.",
"type":"string",
"example":"192.0.2.0"
},
"Hostname":{
"description":"The hostname of the VMware instance.",
"type":"string",
"example":"example3.oracle.com"
},
"Protocol":{
"description":"The protocol used for the REST API URL.",
"type":"string",
"example":"https"
},
"Port":{
"description":"The port number used for the REST API URL.",
"type":"integer",
"example":8080
},
"ZoneID":{
"description":"The zone ID of the VMware instance.",
"type":"integer",
"example":1
},
"DatacenterName":{
"description":"The data center found in the VMware instance.",
"type":"string",
"example":"Oracle-Datacenter"
},
"APIAccessID":{
"description":"The base64-encoded API access ID for the REST API URL.",
"type":"string",
"example":"dGVzdA=="
},
"APIAccessKey":{
"description":"The base64-encoded API access key for the REST API URL.",
"type":"string",
"example":"ZXhhbXBsZQ=="
},
"APIVersion":{
"description":"The VMware version.",
"type":"string",
"example":"7.0.1 7.0.2.0"
},
"Discovered":{
"description":"The discovery status of the VMware instance.",
"type":"boolean",
"enum":[
true,
false
],
"example":true
},
"APIError":{
"description":"The API error status for the VMware discovery.",
"type":"boolean",
"enum":[
true,
false
],
"example":false
},
"ErrorMessage":{
"description":"The error message obtained for the VMware poller when discovery is done.",
"type":"string",
"example":""
},
"HostDiscovery":{
"description":"The list of hosts discovered for the VMware instance.",
"type":"array",
"example":[
{
"ConnectionState":"connected",
"Hostname":"",
"IPAddress":"192.0.2.3",
"Name":"host-16",
"PowerState":"poweredOn"
}
]
},
"VMDiscovery":{
"description":"The list of virtual machines discovered for the VMware instance.",
"type":"array",
"example":[
{
"ConnectionState":"connected",
"Hostname":"api.example.oracle.com",
"IPAddress":"192.0.2.4",
"Name":"vmware-example",
"PowerState":"poweredOn"
}
]
}
}
}
},
"Cisco":{
"description":"Cisco Meraki API data discovered for the discovery.",
"type":"array",
"items":{
"type":"object",
"properties":{
"TargetUrl":{
"description":"The base URL for the Meraki API.",
"type":"string",
"example":"https://api.example.com/api/v1/"
},
"Protocol":{
"description":"The protocol used for the API URL.",
"type":"string",
"example":"https"
},
"Port":{
"description":"The port number used for the API URL.",
"type":"integer",
"example":0
},
"HostName":{
"description":"The hostname for the Meraki API.",
"type":"string",
"example":"api.example.com/api/v1/"
},
"IPAddress":{
"description":"The IP address for the Meraki API (empty in this case).",
"type":"string",
"example":""
},
"ZoneID":{
"description":"The zone ID for the Meraki instance.",
"type":"integer",
"example":1
},
"APIAccessKey":{
"description":"The base64-encoded API access key for the REST API URL.",
"type":"string",
"example":"b3BwbGVkQHRleHQxMjM="
},
"APIVersion":{
"description":"The version of the Meraki API.",
"type":"string",
"example":""
},
"Discovered":{
"description":"Whether the Meraki data was discovered successfully.",
"type":"boolean",
"example":true
},
"APIError":{
"description":"Whether there was an error with the Meraki API.",
"type":"boolean",
"example":false
},
"ErrorMessage":{
"description":"Error message if there was an API error.",
"type":"string",
"example":""
},
"MerakiDiscoveryData":{
"description":"Discovery data for Meraki organizations and networks.",
"type":"object",
"properties":{
"organizations":{
"description":"List of organizations discovered by the Meraki API.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The unique ID of the organization.",
"type":"string",
"example":"205211"
},
"name":{
"description":"The name of the organization.",
"type":"string",
"example":"ACME"
},
"url":{
"description":"URL for the organization overview.",
"type":"string",
"example":"https://n35.example.com/o/MciQXa/manage/organization/overview"
},
"networks":{
"description":"List of networks within the organization.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The unique ID of the network.",
"type":"string",
"example":"L_582653201791065564"
},
"organizationId":{
"description":"The organization ID associated with the network.",
"type":"string",
"example":"205211"
},
"name":{
"description":"The name of the network.",
"type":"string",
"example":"DE-Dortmund Staging"
},
"timeZone":{
"description":"The time zone for the network.",
"type":"string",
"example":"GMT"
},
"productTypes":{
"description":"List of product types in the network.",
"type":"array",
"items":{
"type":"string",
"example":"appliance"
}
},
"networkDevices":{
"description":"List of devices associated with the network.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lat":{
"description":"Latitude of the device.",
"type":"number",
"example":37.4180951010362
},
"lng":{
"description":"Longitude of the device.",
"type":"number",
"example":-122.098531723022
},
"serial":{
"description":"The serial number of the device.",
"type":"string",
"example":"XXXX-XXXX-XXXX"
},
"mac":{
"description":"The MAC address of the device.",
"type":"string",
"example":"FF:FF:FF:FF:FF:FF"
},
"url":{
"description":"URL for the device management page.",
"type":"string",
"example":"https://n35.example.com/DE-Dortmund-Stag/n/AN3a-bJ/manage/nodes/new_list/9834197920531"
},
"model":{
"description":"The model of the device.",
"type":"string",
"example":"MX95"
},
"firmware":{
"description":"The firmware version of the device.",
"type":"string",
"example":"wired-19-1-6"
},
"wan1Ip":{
"description":"The WAN IP address of the device.",
"type":"string",
"example":"193.96.193.149"
}
}
}
}
}
}
},
"devices":{
"description":"List of devices in the organization.",
"type":"array",
"items":{
"type":"object",
"properties":{
"address":{
"description":"Address of the device.",
"type":"string",
"example":""
},
"configurationUpdatedAt":{
"description":"The last time the device configuration was updated.",
"type":"string",
"example":"2024-11-17T21:24:54Z"
},
"firmware":{
"description":"The firmware version of the device.",
"type":"string",
"example":"wired-19-1-6"
},
"lat":{
"description":"Latitude of the device.",
"type":"number",
"example":37.4180951010362
},
"lng":{
"description":"Longitude of the device.",
"type":"number",
"example":-122.098531723022
},
"mac":{
"description":"The MAC address of the device.",
"type":"string",
"example":"FF:FF:FF:FF:FF:FF"
},
"model":{
"description":"The model of the device.",
"type":"string",
"example":"MX95"
},
"serial":{
"description":"The serial number of the device.",
"type":"string",
"example":"XXXX-XXXX-XXXX"
},
"url":{
"description":"URL for the device management page.",
"type":"string",
"example":"https://n35.example.com/DE-Dortmund-Stag/n/AN3a-bJ/manage/nodes/new_list/9834197920531"
},
"wan1Ip":{
"description":"The WAN IP address of the device.",
"type":"string",
"example":"193.96.193.149"
}
}
}
}
}
}
}
}
},
"PollTimeACOM":{
"description":"The polling time in seconds for the availability models.",
"type":"integer",
"example":0
},
"PollTimePCOM":{
"description":"The polling time in seconds for the performance models.",
"type":"integer",
"example":0
}
}
}
}
}
}
}
},
"DiscoveryContextIDProfiles":{
"type":"object",
"additionalProperties":{
"$ref":"#/components/schemas/CustomSNMPAccessProfile"
},
"example":{
"df29b366-c3a4-4a89-8ec8-2f1527276c75":{
"Version":2,
"ProfileID":1,
"UUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Priority":1,
"Port":161,
"MTU":1456,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80001adc802417e202b8613f5400000000"
}
},
"47542a02-6cc6-43f8-b39a-7111136bdcaf":{
"Version":1,
"UUID":"47542a02-6cc6-43f8-b39a-7111136bdcaf",
"Priority":2,
"Port":161,
"MTU":1454,
"Auth":{
"Community":"public",
"Username":"user",
"AuthType":"AUTHPRIV",
"AuthPassphrase":"QXV0aFBhc3N3b3Jk",
"AuthProtocol":"SHA256",
"PrivPassphrase":"UHJpdlBhc3N3b3Jk",
"PrivProtocol":"AES",
"AuthEngineID":"80002adc802417e202b8613f5400000000"
}
}
}
},
"InventoryResponse":{
"type":"object",
"properties":{
"Model":{
"description":"The inventory model name.",
"type":"string",
"example":"inventory"
},
"DiscoveryModel":{
"description":"The discovery model name.",
"type":"string",
"example":"discovery"
},
"Type":{
"description":"The inventory type.",
"type":"string",
"example":"device"
},
"Method":{
"description":"The inventory method name.",
"type":"string",
"example":"add"
},
"Version":{
"description":"The inventory version.",
"type":"string",
"example":"0.0.1"
},
"DiscoveryContextID":{
"description":"The ID obtained from discovery request.",
"type":"string",
"example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
},
"ModelData":{
"type":"object",
"properties":{
"Devices":{
"description":"The list of devices discovered.",
"type":"object",
"additionalProperties":{
"properties":{
"ICMPData":{
"description":"The ICMP data discovered for the discovery.",
"type":"object",
"properties":{
"PollTimePCOM":{
"description":"The polling time in seconds for the performance models.",
"type":"integer"
},
"PollTimeACOM":{
"description":"The polling time in seconds for the availability models.",
"type":"integer"
},
"Available":{
"description":"The availability state of the device.",
"type":"boolean",
"enum":[
true,
false
]
},
"Hostname":{
"description":"The hostname of the device.",
"type":"string"
},
"Timestamp":{
"description":"The Unix time in seconds at which icmp data is discovered.",
"type":"integer",
"example":2147483647
},
"IPAddress":{
"description":"The IP address of the device.",
"type":"string"
},
"ZoneID":{
"description":"The zone ID of the device.",
"type":"integer"
},
"Properties":{
"description":"The device properties.",
"type":"object",
"properties":{
"Managed":{
"description":"The status of the devices can be managed. Possible values are true and false.",
"type":"boolean",
"enum":[
true,
false
]
}
}
}
}
},
"SNMPData":{
"description":"The SNMP data discovered for the discovery.",
"type":"object",
"properties":{
"Target":{
"description":"The hostname or IP address of the device.",
"type":"string"
},
"ProfileUUID":{
"description":"The SNMP profile UUID of the device.",
"type":"string"
},
"ProfileID":{
"description":"The SNMP profile ID of the device.",
"type":"integer"
},
"Discovered":{
"description":"The discovery status of the SNMP device.",
"type":"boolean",
"enum":[
true,
false
]
},
"AuthEngineID":{
"description":"The SNMP profile authentication engine ID.",
"type":"string"
},
"DeviceSystemInfo":{
"description":"Information about the SNMP device system.",
"type":"object",
"properties":{
"SerialNumber":{
"description":"The serial number of the SNMP device.",
"type":"string"
},
"SysContact":{
"description":"The primary contact of the SNMP device.",
"type":"string"
},
"SysDescription":{
"description":"The description of the SNMP device.",
"type":"string"
},
"SysLocation":{
"description":"The physical location of the SNMP device being monitored.",
"type":"string"
},
"SysName":{
"description":"The administratively assigned name for the SNMP device.",
"type":"string"
},
"SysOid":{
"description":"The object identifier of the SNMP device.",
"type":"string"
}
}
},
"Performance":{
"description":"The performance data of the SNMP device.",
"type":"array",
"items":{
"type":"object",
"properties":{
"Vendor":{
"description":"The name of the vendor to which the SNMP device belongs.",
"type":"string"
},
"Class":{
"description":"The name of the class to which the SNMP device belongs.",
"type":"string"
},
"SubClass":{
"description":"The name of the sub class to which the SNMP device data belongs.",
"type":"string"
},
"Weight":{
"description":"The importance level for the SNMP device.",
"type":"integer"
},
"ObjectName":{
"description":"The object name of the SNMP device.",
"type":"string"
},
"Discovered":{
"description":"The discovery status of the SNMP device.",
"type":"boolean",
"enum":[
true,
false
]
}
}
}
},
"Availability":{
"description":"The availability data of the SNMP device.",
"type":"array",
"items":{
"type":"object",
"properties":{
"Vendor":{
"description":"The name of the vendor to which the SNMP device belongs.",
"type":"string"
},
"Class":{
"description":"The name of the class to which the SNMP device belongs.",
"type":"string"
},
"SubClass":{
"description":"The name of the sub class to which the SNMP device belongs.",
"type":"string"
},
"Weight":{
"description":"The importance level for the SNMP device.",
"type":"integer"
},
"ObjectName":{
"description":"The object name of the SNMP device.",
"type":"string"
},
"Discovered":{
"description":"The discovery status of the SNMP device.",
"type":"boolean",
"enum":[
true,
false
]
},
"InstanceOid":{
"description":"The instance object identifier of the SNMP device.",
"type":"string"
},
"Instances":{
"description":"Details of the SNMP device instances.",
"type":"array"
}
}
}
},
"WorkerError":{
"description":"The status of the SNMP poller worker error.",
"type":"boolean",
"enum":[
true,
false
]
},
"WorkerErrorMessage":{
"description":"The worker error message obtained from the SNMP poller when discovery is completed.",
"type":"string"
}
}
}
}
},
"example":{
"203.0.113.1":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example1.oracle.com",
"LastRTTNano":221198,
"Timestamp":1702216942,
"IPAddress":"203.0.113.1",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"203.0.113.2":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example2.oracle.com",
"LastRTTNano":645484,
"Timestamp":1702216942,
"IPAddress":"203.0.113.2",
"ZoneID":1
},
"SNMPData":{
"DeviceSystemInfo":{
}
}
},
"203.0.113.3":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example3.oracle.com",
"LastRTTNano":688044,
"Timestamp":1702216942,
"IPAddress":"203.0.113.3",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.1",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example3.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.4"
}
}
},
"192.0.2.2":{
"ICMPData":{
"PollTimePCOM":300,
"PollTimeACOM":300,
"Available":true,
"Hostname":"example4.oracle.com",
"LastRTTNano":1491998,
"Timestamp":1702216942,
"IPAddress":"192.0.2.2",
"ZoneID":1
},
"SNMPData":{
"Target":"192.0.2.3",
"ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
"Discovered":true,
"Method":"BULK",
"DeviceSystemInfo":{
"SysDescription":"Oracle Software",
"SysLocation":"telephone closet, 3rd floor",
"SysName":"example4.oracle.com",
"SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.3"
}
}
}
}
},
"VMWare":{
"description":"The VMware data discovered for the discovery.",
"type":"array",
"items":{
"type":"object",
"properties":{
"TargetURL":{
"description":"The REST API URL of the VMware instance.",
"type":"string",
"example":"https://192.0.2.0:8080"
},
"IPAddress":{
"description":"The REST API IP address of the VMware instance.",
"type":"string",
"example":"192.0.2.0"
},
"Hostname":{
"description":"The hostname of the VMware instance.",
"type":"string",
"example":"example3.oracle.com"
},
"Protocol":{
"description":"The protocol used for the REST API URL.",
"type":"string",
"example":"https"
},
"Port":{
"description":"The port number used for the REST API URL.",
"type":"integer",
"example":8080
},
"ZoneID":{
"description":"The zone ID of the VMware instance.",
"type":"integer",
"example":1
},
"datacenterName":{
"description":"The data center found in the VMware instance.",
"type":"string",
"example":"Oracle-Datacenter"
},
"APIAccessID":{
"description":"The base64-encoded API access ID for the REST API URL.",
"type":"string",
"example":"ZXhhbXBsZQ=="
},
"APIAccessKey":{
"description":"The base64-encoded API access key for the REST API URL.",
"type":"string",
"example":"ZXhhbXBsZQ=="
},
"APIVersion":{
"description":"The VMware version.",
"type":"string",
"example":"7.0.1 7.0.2.0"
},
"PollTimePCOM":{
"description":"The polling time in seconds for the performance models.",
"type":"integer",
"example":300
},
"PollTimeACOM":{
"description":"The polling time in seconds for the availability models.",
"type":"integer",
"example":300
}
}
}
},
"Cisco":{
"description":"Cisco Meraki API data discovered for the discovery.",
"type":"array",
"items":{
"type":"object",
"properties":{
"TargetUrl":{
"description":"The base URL for the Meraki API.",
"type":"string",
"example":"https://api.example.com/api/v1/"
},
"Protocol":{
"description":"The protocol used for the API URL.",
"type":"string",
"example":"https"
},
"Port":{
"description":"The port number used for the API URL.",
"type":"integer",
"example":0
},
"HostName":{
"description":"The hostname for the Meraki API.",
"type":"string",
"example":"api.example.com/api/v1/"
},
"IPAddress":{
"description":"The IP address for the Meraki API (empty in this case).",
"type":"string",
"example":""
},
"ZoneID":{
"description":"The zone ID for the Meraki instance.",
"type":"integer",
"example":1
},
"APIAccessKey":{
"description":"The base64-encoded API access key for the REST API URL.",
"type":"string",
"example":"b3BwbGVkQHRleHQxMjM="
},
"APIVersion":{
"description":"The version of the Meraki API.",
"type":"string",
"example":""
},
"Discovered":{
"description":"Whether the Meraki data was discovered successfully.",
"type":"boolean",
"example":true
},
"APIError":{
"description":"Whether there was an error with the Meraki API.",
"type":"boolean",
"example":false
},
"ErrorMessage":{
"description":"Error message if there was an API error.",
"type":"string",
"example":""
},
"MerakiDiscoveryData":{
"description":"Discovery data for Meraki organizations and networks.",
"type":"object",
"properties":{
"organizations":{
"description":"List of organizations discovered by the Meraki API.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The unique ID of the organization.",
"type":"string",
"example":"205211"
},
"name":{
"description":"The name of the organization.",
"type":"string",
"example":"ACME"
},
"url":{
"description":"URL for the organization overview.",
"type":"string",
"example":"https://n35.example.com/o/MciQXa/manage/organization/overview"
},
"networks":{
"description":"List of networks within the organization.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The unique ID of the network.",
"type":"string",
"example":"L_582653201791065564"
},
"organizationId":{
"description":"The organization ID associated with the network.",
"type":"string",
"example":"205211"
},
"name":{
"description":"The name of the network.",
"type":"string",
"example":"DE-Dortmund Staging"
},
"timeZone":{
"description":"The time zone for the network.",
"type":"string",
"example":"GMT"
},
"productTypes":{
"description":"List of product types in the network.",
"type":"array",
"items":{
"type":"string",
"example":"appliance"
}
},
"networkDevices":{
"description":"List of devices associated with the network.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lat":{
"description":"Latitude of the device.",
"type":"number",
"example":37.4180951010362
},
"lng":{
"description":"Longitude of the device.",
"type":"number",
"example":-122.098531723022
},
"serial":{
"description":"The serial number of the device.",
"type":"string",
"example":"XXXX-XXXX-XXXX"
},
"mac":{
"description":"The MAC address of the device.",
"type":"string",
"example":"FF:FF:FF:FF:FF:FF"
},
"url":{
"description":"URL for the device management page.",
"type":"string",
"example":"https://n35.example.com/DE-Dortmund-Stag/n/AN3a-bJ/manage/nodes/new_list/9834197920531"
},
"model":{
"description":"The model of the device.",
"type":"string",
"example":"MX95"
},
"firmware":{
"description":"The firmware version of the device.",
"type":"string",
"example":"wired-19-1-6"
},
"wan1Ip":{
"description":"The WAN IP address of the device.",
"type":"string",
"example":"193.96.193.149"
}
}
}
}
}
}
},
"devices":{
"description":"List of devices in the organization.",
"type":"array",
"items":{
"type":"object",
"properties":{
"address":{
"description":"Address of the device.",
"type":"string",
"example":""
},
"configurationUpdatedAt":{
"description":"The last time the device configuration was updated.",
"type":"string",
"example":"2024-11-17T21:24:54Z"
},
"firmware":{
"description":"The firmware version of the device.",
"type":"string",
"example":"wired-19-1-6"
},
"lat":{
"description":"Latitude of the device.",
"type":"number",
"example":37.4180951010362
},
"lng":{
"description":"Longitude of the device.",
"type":"number",
"example":-122.098531723022
},
"mac":{
"description":"The MAC address of the device.",
"type":"string",
"example":"FF:FF:FF:FF:FF:FF"
},
"model":{
"description":"The model of the device.",
"type":"string",
"example":"MX95"
},
"serial":{
"description":"The serial number of the device.",
"type":"string",
"example":"XXXX-XXXX-XXXX"
},
"url":{
"description":"URL for the device management page.",
"type":"string",
"example":"https://n35.example.com/DE-Dortmund-Stag/n/AN3a-bJ/manage/nodes/new_list/9834197920531"
},
"wan1Ip":{
"description":"The WAN IP address of the device.",
"type":"string",
"example":"193.96.193.149"
}
}
}
}
}
}
}
}
},
"PollTimeACOM":{
"description":"The polling time in seconds for the availability models.",
"type":"integer",
"example":0
},
"PollTimePCOM":{
"description":"The polling time in seconds for the performance models.",
"type":"integer",
"example":0
}
}
}
}
}
}
}
},
"RediscoveryRequest":{
"type":"object",
"properties":{
"Type":{
"description":"The request type.",
"type":"string",
"enum":[
"rediscovery"
]
},
"Version":{
"description":"The rediscovery version.",
"type":"string",
"example":"1.0.0"
},
"Data":{
"description":"The rediscovery data.",
"type":"object",
"required":[
"apiType"
],
"properties":{
"apiType":{
"description":"The type of REST API.",
"type":"string",
"enum":[
"vmware"
]
},
"Configuration":{
"type":"object",
"properties":{
"ContextExpiryTimeM":{
"description":"The number of minutes the discovery is valid before it gets expired.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":60
},
"IncludedProtocols":{
"description":"Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.",
"type":"array",
"items":{
"type":"integer",
"enum":[
1,
2,
3
],
"example":"1, 2, 3"
}
}
}
},
"IPList":{
"description":"The list of IP addresses.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"192.0.2.0",
"192.0.2.1"
]
},
"InventoryEngine":{
"description":"The inventory engine name.",
"type":"string",
"example":"inventory-engine-name"
},
"TenantID":{
"description":"Rediscovery for TenantID. Optional.",
"type":"integer",
"example":1
}
}
}
}
},
"V2RediscoveryRequest":{
"type":"object",
"properties":{
"Type":{
"description":"The request type.",
"type":"string",
"enum":[
"rediscovery"
]
},
"Version":{
"description":"The rediscovery version.",
"type":"string",
"example":"1.0.0"
},
"Data":{
"description":"The rediscovery data.",
"type":"object",
"required":[
"apiType"
],
"properties":{
"apiType":{
"description":"The type of REST API.",
"type":"string",
"enum":[
"vmware"
]
},
"Configuration":{
"type":"object",
"properties":{
"ContextExpiryTimeM":{
"description":"The number of minutes the discovery is valid before it gets expired.",
"type":"integer",
"minimum":0,
"maximum":2147483647,
"example":60
},
"IncludedProtocols":{
"description":"Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.",
"type":"array",
"items":{
"type":"integer",
"enum":[
1,
2,
3,
4
],
"example":"1, 2, 3, 4"
}
}
}
},
"IPList":{
"description":"The list of IP addresses.",
"type":"array",
"items":{
"type":"string"
},
"example":[
"192.0.2.0",
"192.0.2.1"
]
},
"InventoryEngine":{
"description":"The inventory engine name.",
"type":"string",
"example":"inventory-engine-name"
},
"TenantID":{
"description":"Rediscovery for TenantID. Optional.",
"type":"integer",
"example":1
},
"autoMonitor":{
"description":"Set this to complete rediscovery automatically.",
"type":"boolean",
"example":false
}
}
}
}
}
}
}
}