Get Discovery Results
get
/discovery-service/discovery/request/result/
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.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : DiscoveryResultResponse
Type:
objectThe discovery request results.
Show Source
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"
}
]
}
}
]
}Nested Schema : items
Type:
Show Source
object-
DiscoveryContextID: string
The discovery request ID.Example:
disco-01f107bd-655f-42e0-ae1c-ac4740e734e7 -
ExecutionConfiguration: object
ExecutionConfiguration
The configuration for running discovery.
-
InventoryHandler: string
The inventory handler name.Example:
inventory-engine-name -
Request: object
Request
The configuration provided for discovery.
-
TimestampExpiration: integer
Minimum Value:
0Maximum Value:9223372036854776000The Unix time in seconds when the discovery expired.Example:1702214858 -
TimestampInitiated: integer
Minimum Value:
0Maximum Value:9223372036854776000The Unix time in seconds when the discovery was initiated.Example:1702214858 -
TimeValidS: integer
Minimum Value:
0Maximum Value:9223372036854776000The number of seconds that the discovery is valid.Example:1216
Nested Schema : ExecutionConfiguration
Type:
objectThe configuration for running discovery.
Show Source
-
ContextExpiryTimeM: integer
Minimum Value:
0Maximum Value:2147483647The number of minutes the discovery is valid before expiring.Example:60 -
ForcedProtocolDiscovery: boolean
Allowed Values:
[ true, false ]Whether to enable every discovery protocol, regardless of ICMP results (true) or not (false). -
ICMPConfiguration: array
ICMPConfiguration
The ICMP configuration for discovery.
-
RESTConfiguration: array
RESTConfiguration
The REST configuration for discovery.
-
SNMPConfiguration: array
SNMPConfiguration
The SNMP configuration for discovery.
Nested Schema : Request
Type:
objectThe configuration provided for discovery.
Show Source
-
Configuration: object
Configuration
The ICMP, SNMP and REST configurations for discovery.
-
InventoryEngine: string
The inventory engine name.Example:
inventory-engine-name -
IPList: array
IPList
The list of IP addresses to perform discovery on.
-
IPranges: array
IPranges
The list of IP ranges to perform discovery on. Supports CIDR ranges.
-
Level: array
Level
The types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
Nested Schema : ICMPConfiguration
Type:
arrayThe ICMP configuration for discovery.
Show Source
-
Array of:
object ICMPConfiguration
The ICMP payload configuration.
Nested Schema : RESTConfiguration
Type:
arrayThe REST configuration for discovery.
Show Source
-
Array of:
object RESTConfiguration
REST configurations for VMWare, MIST, Cisco, Aruba, and Cisco DNA connections.
Nested Schema : SNMPConfiguration
Type:
arrayThe SNMP configuration for discovery.
Show Source
-
Array of:
object SNMPConfiguration
The SNMP payload configuration.
Nested Schema : ICMPConfiguration
Type:
objectThe ICMP payload configuration.
Show Source
-
CascadeMs: integer
Minimum Value:
0Maximum Value:2147483647The number of milliseconds between two successful pings.Example:5 -
Count: integer
Minimum Value:
0Maximum Value:2147483647The number of ping requests to send.Example:5 -
Mode(required): integer
Allowed Values:
[ 0, 1 ]The ICMP mode. Possible values are 0 for synchronous and 1 for asynchronous.Example:1 -
TimeoutS: integer
Minimum Value:
0Maximum Value:2147483647The number of seconds to wait for a ping response.Example:10
Nested Schema : RESTConfiguration
Type:
objectREST configurations for VMWare, MIST, Cisco, Aruba, and Cisco DNA connections.
Show Source
-
APIAccessID: string
The base64-encoded API access ID for the REST API URL.Example:
dGVzdA== -
APIAccessKey: string
The base64-encoded API access key for the REST API URL.Example:
ZXhhbXBsZQ== -
APIType(required): string
Allowed Values:
[ "vmware", "mist", "cisco", "aruba", "ciscodna" ]The REST API type.Example:vmware -
CloudName: string
The cloud name for the REST API connection.
-
CustomerIDs: array
CustomerIDs
Customer IDs to include in cloud API discovery.
-
Port: integer
Minimum Value:
0Maximum Value:65535The port number for the REST API URL.Example:8080 -
Protocol(required): string
Allowed Values:
[ "http", "https" ]The protocol used for the REST API.Example:https -
RootClientID: string
The root client ID for cloud API discovery.
-
RootCustomerID: string
The root customer ID for cloud API discovery.
-
Url: string
The REST API URL.Example:
192.0.2.0
Nested Schema : SNMPConfiguration
Type:
objectThe SNMP payload configuration.
Show Source
-
CustomSNMPAccessProfiles: array
CustomSNMPAccessProfiles
The list of custom SNMP access profiles.
-
IsTCP: boolean
Allowed Values:
[ true, false ]Whether SNMP is implemented over TCP (true) or not (false).Example:false -
Method: string
Allowed Values:
[ "BULK", "NEXT" ]The SNMP method.Example:BULK -
NetworkOptions: object
NetworkOptions
Network options for SNMP communication.
Nested Schema : CustomSNMPAccessProfiles
Type:
arrayThe list of custom SNMP access profiles.
Show Source
-
Array of:
object CustomSNMPAccessProfile
A custom SNMP access profile.
Nested Schema : NetworkOptions
Type:
objectNetwork options for SNMP communication.
Show Source
-
ExponentialTimeout: boolean
Allowed Values:
[ true, false ]The status is enabled to timeout exponentially if the request fails.Example:false -
MaxOids: integer
Minimum Value:
0Maximum Value:128The maximum SNMP OID value.Example:100 -
MaxRepetitions: integer
Minimum Value:
0Maximum Value:2147483647The maximum number of repetitions.Example:50 -
NonRepeaters: integer
Minimum Value:
0Maximum Value:2147483647The number of non repeaters.Example:1 -
Retries: integer
Minimum Value:
0Maximum Value:2147483647The number of times to retry the request.Example:3 -
Timeout: string
Allowed Values:
[ "1s", "2m", "3h", "4d" ]The number of seconds, minutes, hours, or days before the request times out.Example:5s
Nested Schema : CustomSNMPAccessProfile
Type:
objectA custom SNMP access profile.
Show Source
-
Auth: object
CustomSNMPAccessProfileAuth
Custom SNMP access profile authentication information.
-
MTU: integer
Minimum Value:
484Maximum Value:2147483647The MTU for the custom SNMP access profile. The value must be at least 484.Example:1456 -
Port: integer
Minimum Value:
1Maximum Value:65535The custom SNMP access profile port.Example:161 -
Priority: integer
Minimum Value:
0Maximum Value:2147483647The custom SNMP access profile priority.Example:1 -
ProfileID: integer
Allowed Values:
[ 0 ]The custom SNMP access profile ID. Custom profiles must use the default value 0.Example:0 -
UUID: string
(uuid)
The custom SNMP access profile UUID.Example:
df29b366-c3a4-4a89-8ec8-2f1527276c75 -
Version(required): integer
Allowed Values:
[ 1, 2, 3 ]The custom SNMP access profile version.Example:2
Nested Schema : CustomSNMPAccessProfileAuth
Type:
objectCustom SNMP access profile authentication information.
Show Source
-
AuthEngineID: string
The custom SNMP access profile authentication engine ID.Example:
80001adc802417e202b8613f5400000000 -
AuthPassphrase: string
The custom SNMP access profile authentication passphrase.Example:
QXV0aFBhc3N3b3Jk -
AuthProtocol: string
The custom SNMP access profile authentication protocol.Example:
SHA256 -
AuthType: string
Allowed Values:
[ "NOAUTHNOPRIV", "AUTHNOPRIV", "AUTHPRIV" ]The custom SNMP access profile authentication type.Example:AUTHPRIV -
Community: string
The custom SNMP access profile community string.Example:
public -
PrivPassphrase: string
The custom SNMP access profile private passphrase.Example:
UHJpdlBhc3N3b3Jk -
PrivProtocol: string
The custom SNMP access profile private protocol.Example:
AES -
Username: string
The custom SNMP access profile user name.Example:
user
Nested Schema : Configuration
Type:
objectThe ICMP, SNMP and REST configurations for discovery.
Show Source
-
ContextExpiryTimeM: integer
Minimum Value:
0Maximum Value:2147483647The number of minutes the discovery is valid before expiring.Example:60 -
ForcedProtocolDiscovery: boolean
Allowed Values:
[ true, false ]Whether to enable every discovery protocol, regardless of ICMP results (true) or not (false). -
ICMPConfiguration: array
ICMPConfiguration
The ICMP configuration for discovery.
-
RESTConfiguration: array
RESTConfiguration
The REST configuration for discovery.
-
SNMPConfiguration: array
SNMPConfiguration
The SNMP configuration for discovery.
Nested Schema : IPList
Type:
arrayThe list of IP addresses to perform discovery on.
Show Source
Example:
[
"203.0.113.0",
"203.0.113.1"
]Nested Schema : IPranges
Type:
arrayThe list of IP ranges to perform discovery on. Supports CIDR ranges.
Show Source
Example:
[
"192.0.2.0/24",
"198.51.100.0-198.51.100.5"
]Nested Schema : Level
Type:
arrayThe types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
Show Source
-
Array of:
integer
Allowed Values:
[ 1, 2, 3 ]Example:[ 1, 2, 3 ]
Nested Schema : ICMPConfiguration
Type:
arrayThe ICMP configuration for discovery.
Show Source
-
Array of:
object ICMPConfiguration
The ICMP payload configuration.
Nested Schema : RESTConfiguration
Type:
arrayThe REST configuration for discovery.
Show Source
-
Array of:
object RESTConfiguration
REST configurations for VMWare, MIST, Cisco, Aruba, and Cisco DNA connections.
Nested Schema : SNMPConfiguration
Type:
arrayThe SNMP configuration for discovery.
Show Source
-
Array of:
object SNMPConfiguration
The SNMP payload configuration.
401 Response
Unauthorized operation
500 Response
Internal server error