Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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

{
    "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 <b>1</b> for ping, <b>2</b> for SNMP, and <b>3</b> 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":9.223372036854776E18,
            "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
        }
    }
}

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: [ 1, 2, 3 ]

Show Source

• Array of: integer

{
    "description":"The types of polling enabled for discovery. Possible values are <b>1</b> for ping, <b>2</b> for SNMP, and <b>3</b> for REST.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "enum":[
        1,
        2,
        3
    ],
    "example":[
        1,
        2,
        3
    ]
}

Example:

[
    1,
    2,
    3
]

204 Response

No content

401 Response

Unauthorized operation

500 Response

Internal server error

Back to Top