Jump to

• Request
• Response

Start an Auto Discovery or SNMP Discovery Job

get

/api/discovery/Discover/executeRun

Starts an auto discovery or SNMP discovery job on the server that matches the specified ID.

Request

Query Parameters

• DeviceHosts(required): string
  The comma-separated list of IP Addresses or FQDNs for devices.

  Example:

  100.77.220.52, 100.77.220.19

• JobID(required): integer
  The job ID on the specified server.

  Example:

  1

• JobName: string
  The job name on the specified server.

  Example:

  Device Auto Discovery

• ServerID(required): integer
  The server ID to remotely execute discovery. If specified, only the array of jobs is returned. If not, only the array of servers is returned.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• message: string
  The response message.

  Example: Device Auto Discovery: Process queued to start
• success: boolean
  Whether the operation was a success (true) or failure (false).

  Example: true

{
    "type":"object",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Device Auto Discovery: Process queued to start"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top