Get Discovery Results by ID
get
/discovery/request/result/{discovery-context-id}
Gets the result of the discovery request that matches the specified discovery context ID.
Request
Path Parameters
-
discovery-context-id(required): string
The ID for the discovery request to get results for.
Query Parameters
-
discoveredOnly: boolean
Whether to display only discovered requests (true) or not (false).
-
withErrors: boolean
Whether to enable errors (true) or not (false).
-
withWarnings: boolean
Whether to enable warnings (true) or not (false).
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : DiscoveryContextIDResultResponse
Type:
objectThe discovery result containing the discovery context id.
Show Source
-
DiscoveryContextID: string
The ID obtained from discovery request.Example:
disco-01f107bd-655f-42e0-ae1c-ac4740e734e7 -
Model: string
The discovery model name.Example:
discovery -
ModelData: object
ModelData
The discovery result data.
-
Type: string
The discovery type.Example:
ping -
Version: string
The discovery version.Example:
0.0.1
Nested Schema : ModelData
Type:
objectThe discovery result data.
Show Source
-
Cisco: array
Cisco
Cisco Meraki API data discovered for the discovery.
-
Devices: object
Devices
Additional Properties Allowed: additionalPropertiesThe list of the devices discovered.
-
VMWare: array
VMWare
The VMware data discovered for the discovery.
Nested Schema : Devices
Type:
objectAdditional Properties Allowed
Show Source
The list of the devices discovered.
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"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
APIAccessKey: string
The base64-encoded API access key for the REST API URL.Example:
b3BwbGVkQHRleHQxMjM= -
APIError: boolean
Whether there was an error with the Meraki API.Example:
false -
APIVersion: string
The version of the Meraki API.Example:
-
Discovered: boolean
Whether the Meraki data was discovered successfully.Example:
true -
ErrorMessage: string
Error message if there was an API error.Example:
-
HostName: string
The hostname for the Meraki API.Example:
api.example.com/api/v1/ -
IPAddress: string
The IP address for the Meraki API (empty in this case).Example:
-
MerakiDiscoveryData: object
MerakiDiscoveryData
Discovery data for Meraki organizations and networks.
-
PollTimeACOM: integer
The polling time in seconds for the availability models.Example:
0 -
PollTimePCOM: integer
The polling time in seconds for the performance models.Example:
0 -
Port: integer
The port number used for the API URL.Example:
0 -
Protocol: string
The protocol used for the API URL.Example:
https -
TargetUrl: string
The base URL for the Meraki API.Example:
https://api.example.com/api/v1/ -
ZoneID: integer
The zone ID for the Meraki instance.Example:
1
Nested Schema : MerakiDiscoveryData
Type:
objectDiscovery data for Meraki organizations and networks.
Show Source
-
organizations: array
organizations
List of organizations discovered by the Meraki API.
Nested Schema : organizations
Type:
arrayList of organizations discovered by the Meraki API.
Show Source
Nested Schema : items
Type:
Show Source
object-
devices: array
devices
List of devices in the organization.
-
id: string
The unique ID of the organization.Example:
205211 -
name: string
The name of the organization.Example:
ACME -
networks: array
networks
List of networks within the organization.
-
url: string
URL for the organization overview.Example:
https://n35.example.com/o/MciQXa/manage/organization/overview
Nested Schema : items
Type:
Show Source
object-
address: string
Address of the device.Example:
-
configurationUpdatedAt: string
The last time the device configuration was updated.Example:
2024-11-17T21:24:54Z -
firmware: string
The firmware version of the device.Example:
wired-19-1-6 -
lat: number
Latitude of the device.Example:
37.4180951010362 -
lng: number
Longitude of the device.Example:
-122.098531723022 -
mac: string
The MAC address of the device.Example:
FF:FF:FF:FF:FF:FF -
model: string
The model of the device.Example:
MX95 -
serial: string
The serial number of the device.Example:
XXXX-XXXX-XXXX -
url: string
URL for the device management page.Example:
https://n35.example.com/DE-Dortmund-Stag/n/AN3a-bJ/manage/nodes/new_list/9834197920531 -
wan1Ip: string
The WAN IP address of the device.Example:
193.96.193.149
Nested Schema : items
Type:
Show Source
object-
id: string
The unique ID of the network.Example:
L_582653201791065564 -
name: string
The name of the network.Example:
DE-Dortmund Staging -
networkDevices: array
networkDevices
List of devices associated with the network.
-
organizationId: string
The organization ID associated with the network.Example:
205211 -
productTypes: array
productTypes
List of product types in the network.
-
timeZone: string
The time zone for the network.Example:
GMT
Nested Schema : productTypes
Type:
arrayList of product types in the network.
Show Source
-
Array of:
string
Example:
appliance
Nested Schema : items
Type:
Show Source
object-
firmware: string
The firmware version of the device.Example:
wired-19-1-6 -
lat: number
Latitude of the device.Example:
37.4180951010362 -
lng: number
Longitude of the device.Example:
-122.098531723022 -
mac: string
The MAC address of the device.Example:
FF:FF:FF:FF:FF:FF -
model: string
The model of the device.Example:
MX95 -
serial: string
The serial number of the device.Example:
XXXX-XXXX-XXXX -
url: string
URL for the device management page.Example:
https://n35.example.com/DE-Dortmund-Stag/n/AN3a-bJ/manage/nodes/new_list/9834197920531 -
wan1Ip: string
The WAN IP address of the device.Example:
193.96.193.149
Nested Schema : additionalProperties
Type:
Show Source
object-
ICMPData: object
ICMPData
The ICMP data discovered for the discovery.
-
SNMPData: object
SNMPData
The SNMP data discovered for the discovery.
Nested Schema : ICMPData
Type:
objectThe ICMP data discovered for the discovery.
Show Source
-
Available: boolean
Allowed Values:
[ true, false ]The availability state of the device. -
Hostname: string
The hostname of the device.
-
IPAddress: string
The IP address of the device.
-
LastRTTNano: integer
The round trip time in nano seconds.
-
Timestamp: integer
The unix time in seconds at which icmp data is discovered.Example:
2147483647 -
WorkerError: boolean
Allowed Values:
[ true, false ]The status of the ping poller worker error. -
WorkerErrorMessage: string
The worker error message obtained from the ping poller when discovery is done.Example:
ICMP configuration failed -
ZoneID: integer
The zone id of the device.
Nested Schema : SNMPData
Type:
objectThe SNMP data discovered for the discovery.
Show Source
-
AuthEngineID: string
The SNMP profile authentication engine ID.
-
Availability: array
Availability
The availability data of the SNMP device.
-
DeviceSystemInfo: object
DeviceSystemInfo
The information about SNMP device system.
-
Discovered: boolean
Allowed Values:
[ true, false ]The discovery status of the SNMP device. -
Performance: array
Performance
The performance data of the SNMP device.
-
ProfileID: integer
The SNMP profile IP of the device.
-
ProfileUUID: string
The SNMP profile UUID of the device.
-
Target: string
The hostname or IP address of the device.
-
WorkerError: boolean
Allowed Values:
[ true, false ]The status of the snmp poller worker error. -
WorkerErrorMessage: string
The worker error message obtained from the snmp poller when discovery is done.
Nested Schema : DeviceSystemInfo
Type:
objectThe information about SNMP device system.
Show Source
-
SerialNumber: string
The serial number of the SNMP device.
-
SysContact: string
The primary contact of the SNMP device.
-
SysDescription: string
The description of the SNMP device.
-
SysLocation: string
The physical location of the SNMP device being monitored.
-
SysName: string
The administrative assigned name for the SNMP device.
-
SysOid: string
The object identifier of the SNMP device.
Nested Schema : items
Type:
Show Source
object-
Class: string
The class name to which the SNMP device belongs to.
-
Discovered: boolean
Allowed Values:
[ true, false ]The discovery status of the SNMP device. -
InstanceOid: string
The instance object identifier of the SNMP device.
-
Instances: array
Instances
The instance details of the SNMP device.
-
ObjectName: string
The object name of the SNMP device.
-
SubClass: string
The sub class name to which the SNMP device data belongs to.
-
Vendor: string
The vendor name to which the SNMP device belongs to.
-
Weight: integer
The importance level for the SNMP device.
Nested Schema : Instances
Type:
arrayThe instance details of the SNMP device.
Nested Schema : items
Type:
Show Source
object-
Class: string
The class name to which the SNMP device belongs to.
-
Discovered: boolean
Allowed Values:
[ true, false ]The discovery status of the SNMP device. -
ObjectName: string
The object name of the SNMP device.
-
SubClass: string
The sub class name to which the SNMP device belongs to.
-
Vendor: string
The vendor name to which the SNMP device belongs to.
-
Weight: integer
The importance level for the SNMP device.
Nested Schema : items
Type:
Show Source
object-
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== -
APIError: boolean
Allowed Values:
[ true, false ]The API error status for the VMware discovery.Example:false -
APIVersion: string
The VMware version.Example:
7.0.1 7.0.2.0 -
DatacenterName: string
The data center found in the VMware instance.Example:
Oracle-Datacenter -
Discovered: boolean
Allowed Values:
[ true, false ]The discovery status of the VMware instance.Example:true -
ErrorMessage: string
The error message obtained for the VMware poller when discovery is done..Example:
-
HostDiscovery: array
HostDiscovery
The list of hosts discovered for the VMware instance.
-
Hostname: string
The hostname of the VMware instance.Example:
example3.oracle.com -
IPAddress: string
The REST API IP address of the VMware instance.Example:
192.0.2.0 -
Port: integer
The port number used for the REST API URL.Example:
8080 -
Protocol: string
The protocol used for the REST API URL.Example:
https -
TargetURL: string
The REST API URL of the VMware instance.Example:
https://192.0.2.0:8080 -
VMDiscovery: array
VMDiscovery
The list of virtual machines discovered for the VMware instance.
-
ZoneID: integer
The zone id of the VMware instance.Example:
1
Nested Schema : HostDiscovery
Type:
arrayThe list of hosts discovered for the VMware instance.
Example:
[
{
"ConnectionState":"connected",
"Hostname":"",
"IPAddress":"192.0.2.3",
"Name":"host-16",
"PowerState":"poweredOn"
}
]Nested Schema : VMDiscovery
Type:
arrayThe list of virtual machines discovered for the VMware instance.
Example:
[
{
"ConnectionState":"connected",
"Hostname":"api.example.oracle.com",
"IPAddress":"192.0.2.4",
"Name":"vmware-example",
"PowerState":"poweredOn"
}
]204 Response
No content
401 Response
Unauthorized operation
500 Response
Internal server error