Get Discovery Status by ID
get
/discovery/request/status/{discovery-context-id}
Gets the status 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 status for.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : DiscoveryContextIDStatusResponse
Type:
object
The status of a discovery request.
Show Source
-
APIProgress: integer
Minimum Value:
0
Maximum Value:2147483647
The number of REST API jobs completed for the discovery.Example:6
-
APIStatus: string
Allowed Values:
[ "In Progress", "Completed", "NA" ]
The REST API discovery status.Example:Completed
-
APITotal: integer
Minimum Value:
0
Maximum Value:2147483647
The number of REST API jobs requested for the discovery.Example:6
-
DiscoveryContextID: string
The discovery request ID.Example:
disco-01f107bd-655f-42e0-ae1c-ac4740e734e7
-
ICMPProgress: integer
Minimum Value:
0
Maximum Value:2147483647
The number of ICMP jobs completed for the discovery.Example:6
-
ICMPStatus: string
Allowed Values:
[ "In Progress", "Completed", "NA" ]
The ICMP discovery status.Example:Completed
-
ICMPTotal: integer
Minimum Value:
0
Maximum Value:2147483647
The number of ICMP jobs requested for the discovery.Example:6
-
RequestedLevel: array
RequestedLevel
The types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
-
SNMPProgress: integer
Minimum Value:
0
Maximum Value:2147483647
The number of SNMP jobs completed for the discovery.Example:6
-
SNMPStatus: string
Allowed Values:
[ "In Progress", "Completed", "NA" ]
The SNMP discovery status.Example:Completed
-
SNMPTotal: integer
Minimum Value:
0
Maximum Value:2147483647
The number of SNMP jobs requested for the discovery.Example:6
-
TimestampInitiated: integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
The unix time in seconds when discovery was initiated.Example:1702215346
Nested Schema : RequestedLevel
Type:
array
The types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
Allowed Values:
Show Source
[
1,
2,
3
]
Example:
[
1,
2,
3
]
204 Response
No content
401 Response
Unauthorized operation
500 Response
Internal server error