Jump to

• Request
• Response

Create a Discovery Job

post

/discovery/request/create

Creates a new job to discover devices.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The payload for a discovery request.

Show Source

• Data: object Data
  The discovery request data.
• Type: string
  Allowed Values: [ "discovery" ]

  The type of discovery.
• Version: string
  The discovery version.

  Example: 1.0.0

{
    "type":"object",
    "description":"The payload for a discovery request.",
    "properties":{
        "Type":{
            "description":"The type of discovery.",
            "type":"string",
            "enum":[
                "discovery"
            ]
        },
        "Version":{
            "description":"The discovery version.",
            "type":"string",
            "example":"1.0.0"
        },
        "Data":{
            "description":"The discovery request data.",
            "type":"object",
            "properties":{
                "Configuration":{
                    "description":"The ICMP, SNMP and REST Configuration for discovery.",
                    "type":"object",
                    "properties":{
                        "ForcedProtocolDiscovery":{
                            "description":"Whether to discover every protocol regardless of ICMP result (<b>true</b>) or not (<b>false</b>).",
                            "type":"boolean",
                            "enum":[
                                true,
                                false
                            ]
                        },
                        "ContextExpiryTimeM":{
                            "description":"The number of minutes before the discovery expires.",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"2147483647",
                            "example":"60"
                        },
                        "ICMPConfiguration":{
                            "description":"The list of ICMP configurations.",
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/ICMPConfiguration"
                            }
                        },
                        "SNMPConfiguration":{
                            "description":"The list of SNMP configurations.",
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/SNMPConfiguration"
                            }
                        },
                        "RESTConfiguration":{
                            "description":"The list of REST configurations.",
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/RESTConfiguration"
                            }
                        }
                    }
                },
                "IPranges":{
                    "description":"List of IP Ranges. Supports CIDR ranges.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "example":[
                        "192.0.2.0/24",
                        "198.51.100.0-198.51.100.5"
                    ]
                },
                "IPList":{
                    "description":"List of IP Addresses.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "example":[
                        "203.0.113.0",
                        "203.0.113.1"
                    ]
                },
                "Level":{
                    "description":"Type 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"
                    ]
                },
                "InventoryEngine":{
                    "description":"Discovery inventory engine name.",
                    "type":"string",
                    "example":"inventory-engine-name"
                }
            }
        }
    }
}

Nested Schema : Data

Type: object

The discovery request data.

Show Source

• Configuration: object Configuration
  The ICMP, SNMP and REST Configuration for discovery.
• InventoryEngine: string
  Discovery inventory engine name.

  Example: inventory-engine-name
• IPList: array IPList
  List of IP Addresses.
• IPranges: array IPranges
  List of IP Ranges. Supports CIDR ranges.
• Level: array Level
  Type of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.

{
    "description":"The discovery request data.",
    "type":"object",
    "properties":{
        "Configuration":{
            "description":"The ICMP, SNMP and REST Configuration for discovery.",
            "type":"object",
            "properties":{
                "ForcedProtocolDiscovery":{
                    "description":"Whether to discover every protocol regardless of ICMP result (<b>true</b>) or not (<b>false</b>).",
                    "type":"boolean",
                    "enum":[
                        true,
                        false
                    ]
                },
                "ContextExpiryTimeM":{
                    "description":"The number of minutes before the discovery expires.",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"2147483647",
                    "example":"60"
                },
                "ICMPConfiguration":{
                    "description":"The list of ICMP configurations.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ICMPConfiguration"
                    }
                },
                "SNMPConfiguration":{
                    "description":"The list of SNMP configurations.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SNMPConfiguration"
                    }
                },
                "RESTConfiguration":{
                    "description":"The list of REST configurations.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RESTConfiguration"
                    }
                }
            }
        },
        "IPranges":{
            "description":"List of IP Ranges. Supports CIDR ranges.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "192.0.2.0/24",
                "198.51.100.0-198.51.100.5"
            ]
        },
        "IPList":{
            "description":"List of IP Addresses.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "203.0.113.0",
                "203.0.113.1"
            ]
        },
        "Level":{
            "description":"Type 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"
            ]
        },
        "InventoryEngine":{
            "description":"Discovery inventory engine name.",
            "type":"string",
            "example":"inventory-engine-name"
        }
    }
}

Nested Schema : Configuration

Type: object

The ICMP, SNMP and REST Configuration for discovery.

Show Source

• ContextExpiryTimeM: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of minutes before the discovery expires.

  Example: 60
• ForcedProtocolDiscovery: boolean
  Allowed Values: [ true, false ]

  Whether to discover every protocol regardless of ICMP result (true) or not (false).
• ICMPConfiguration: array ICMPConfiguration
  The list of ICMP configurations.
• RESTConfiguration: array RESTConfiguration
  The list of REST configurations.
• SNMPConfiguration: array SNMPConfiguration
  The list of SNMP configurations.

{
    "description":"The ICMP, SNMP and REST Configuration for discovery.",
    "type":"object",
    "properties":{
        "ForcedProtocolDiscovery":{
            "description":"Whether to discover every protocol regardless of ICMP result (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "enum":[
                true,
                false
            ]
        },
        "ContextExpiryTimeM":{
            "description":"The number of minutes before the discovery expires.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"60"
        },
        "ICMPConfiguration":{
            "description":"The list of ICMP configurations.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ICMPConfiguration"
            }
        },
        "SNMPConfiguration":{
            "description":"The list of SNMP configurations.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SNMPConfiguration"
            }
        },
        "RESTConfiguration":{
            "description":"The list of REST configurations.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RESTConfiguration"
            }
        }
    }
}

Nested Schema : IPList

Type: array

List of IP Addresses.

Show Source

• Array of: string

{
    "description":"List of IP Addresses.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "203.0.113.0",
        "203.0.113.1"
    ]
}

Example:

[
    "203.0.113.0",
    "203.0.113.1"
]

Nested Schema : IPranges

Type: array

List of IP Ranges. Supports CIDR ranges.

Show Source

• Array of: string

{
    "description":"List of IP Ranges. Supports CIDR ranges.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "192.0.2.0/24",
        "198.51.100.0-198.51.100.5"
    ]
}

Example:

[
    "192.0.2.0/24",
    "198.51.100.0-198.51.100.5"
]

Nested Schema : Level

Type: array

Type 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" ]

{
    "description":"Type 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"
]

Nested Schema : ICMPConfiguration

Type: array

The list of ICMP configurations.

Show Source

• Array of: object ICMPConfiguration
  The ICMP payload configuration.

{
    "description":"The list of ICMP configurations.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ICMPConfiguration"
    }
}

Nested Schema : RESTConfiguration

Type: array

The list of REST configurations.

Show Source

• Array of: object RESTConfiguration
  REST configurations for Juniper MIST and VMWare connections.

{
    "description":"The list of REST configurations.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RESTConfiguration"
    }
}

Nested Schema : SNMPConfiguration

Type: array

The list of SNMP configurations.

Show Source

• Array of: object SNMPConfiguration
  The SNMP payload configuration.

{
    "description":"The list of SNMP configurations.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SNMPConfiguration"
    }
}

Nested Schema : ICMPConfiguration

Type: object

The ICMP payload configuration.

Show Source

• CascadeMs: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of milliseconds between two successful pings.

  Example: 5
• Count: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The 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: 0

  Maximum Value: 2147483647

  The number of milliseconds to wait for the ping message corresponding to a given ping message.

  Example: 10

{
    "description":"The ICMP payload configuration.",
    "type":"object",
    "required":[
        "Mode"
    ],
    "properties":{
        "Mode":{
            "description":"The ICMP mode. Possible values are <b>0</b> for synchronous and <b>1</b> for asynchronous.",
            "type":"integer",
            "enum":[
                "0",
                "1"
            ],
            "example":"1"
        },
        "Timeouts":{
            "description":"The number of milliseconds to wait for the ping message corresponding to a given ping message.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"10"
        },
        "Count":{
            "description":"The number of ping requests to send.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"5"
        },
        "CascadeMs":{
            "description":"The number of milliseconds between two successful pings.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"5"
        }
    }
}

Nested Schema : RESTConfiguration

Type: object

REST configurations for Juniper MIST and VMWare 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: dGVzdA==
• APIType(required): string
  Allowed Values: [ "vmware" ]

  The REST API type.

  Example: vmware
• Port: integer
  Minimum Value: 0

  Maximum Value: 65535

  The 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
• Url: string
  The REST API URL for VMWare or Mist.

  Example: 192.0.2.0

{
    "description":"REST configurations for Juniper MIST and VMWare connections.",
    "type":"object",
    "required":[
        "Protocol",
        "APIType"
    ],
    "properties":{
        "Url":{
            "description":"The REST API URL for VMWare or Mist.",
            "type":"string",
            "example":"192.0.2.0"
        },
        "Protocol":{
            "description":"The protocol used for the REST API.",
            "type":"string",
            "enum":[
                "http",
                "https"
            ],
            "example":"https"
        },
        "Port":{
            "description":"The port number for the REST API URL.",
            "type":"integer",
            "minimum":"0",
            "maximum":"65535",
            "example":"8080"
        },
        "APIAccessID":{
            "description":"The base64-encoded API access ID for the REST API URL.",
            "type":"string",
            "example":"dGVzdA=="
        },
        "APIAccessKey":{
            "description":"The base64-encoded API access key for the REST API URL.",
            "type":"string",
            "example":"dGVzdA=="
        },
        "APIType":{
            "description":"The REST API type.",
            "type":"string",
            "enum":[
                "vmware"
            ],
            "example":"vmware"
        }
    }
}

Nested Schema : SNMPConfiguration

Type: object

The SNMP payload configuration.

Show Source

• CustomSNMPAccessProfiles: array CustomSNMPAccessProfiles
  The list of custom SNMP access profiles.
• ExponentialTimeout: boolean
  Allowed Values: [ true, false ]

  The status is enabled to timeout exponentially if the request fails.

  Example: false
• IsTCP: boolean
  Allowed Values: [ true, false ]

  Whether SNMP is implemented over TCP (true) or not (false).

  Example: false
• MaxOids: integer
  Minimum Value: 0

  Maximum Value: 128

  The maximum SNMP OID value.

  Example: 100
• MaxRepetitions: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The maximum number of repetitions.

  Example: 50
• Method: string
  Allowed Values: [ "BULK", "GET" ]

  The SNMP method.

  Example: BULK
• NonRepeaters: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of non repeaters.

  Example: 1
• Retries: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The 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

{
    "description":"The SNMP payload configuration.",
    "type":"object",
    "properties":{
        "Method":{
            "description":"The SNMP method.",
            "type":"string",
            "enum":[
                "BULK",
                "GET"
            ],
            "example":"BULK"
        },
        "IsTCP":{
            "description":"Whether SNMP is implemented over TCP (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "enum":[
                true,
                false
            ],
            "example":false
        },
        "Timeout":{
            "description":"The number of seconds, minutes, hours, or days before the request times out.",
            "type":"string",
            "enum":[
                "1s",
                "2m",
                "3h",
                "4d"
            ],
            "example":"5s"
        },
        "ExponentialTimeout":{
            "description":"The status is enabled to timeout exponentially if the request fails.",
            "type":"boolean",
            "enum":[
                true,
                false
            ],
            "example":false
        },
        "Retries":{
            "description":"The number of times to retry the request.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"3"
        },
        "MaxOids":{
            "description":"The maximum SNMP OID value.",
            "type":"integer",
            "minimum":"0",
            "maximum":"128",
            "example":"100"
        },
        "MaxRepetitions":{
            "description":"The maximum number of repetitions.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"50"
        },
        "NonRepeaters":{
            "description":"The number of non repeaters.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"1"
        },
        "CustomSNMPAccessProfiles":{
            "description":"The list of custom SNMP access profiles.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomSNMPAccessProfile"
            }
        }
    }
}

Nested Schema : CustomSNMPAccessProfiles

Type: array

The list of custom SNMP access profiles.

Show Source

• Array of: object CustomSNMPAccessProfile
  A custom SNMP access profile.

{
    "description":"The list of custom SNMP access profiles.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomSNMPAccessProfile"
    }
}

Nested Schema : CustomSNMPAccessProfile

Type: object

A custom SNMP access profile.

Show Source

• Auth: object CustomSNMPAccessProfileAuth
  Custom SNMP access profile authentication information.
• MTU: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The MTU for the custom SNMP access profile.

  Example: 1456
• Port: integer
  Minimum Value: 0

  Maximum Value: 65535

  The custom SNMP access profile port.

  Example: 161
• Priority: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The custom SNMP access profile priority.

  Example: 1
• ProfileID: integer
  Minimum Value: 0

  Maximum Value: 4294967295

  The custom SNMP access profile ID.

  Example: 1
• 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

{
    "description":"A custom SNMP access profile.",
    "type":"object",
    "required":[
        "Version"
    ],
    "properties":{
        "Version":{
            "description":"The custom SNMP access profile version.",
            "type":"integer",
            "enum":[
                "1",
                "2",
                "3"
            ],
            "example":"2"
        },
        "ProfileID":{
            "description":"The custom SNMP access profile ID.",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295",
            "example":"1"
        },
        "UUID":{
            "description":"The custom SNMP access profile UUID.",
            "type":"string",
            "format":"uuid",
            "example":"df29b366-c3a4-4a89-8ec8-2f1527276c75"
        },
        "Priority":{
            "description":"The custom SNMP access profile priority.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"1"
        },
        "Port":{
            "description":"The custom SNMP access profile port.",
            "type":"integer",
            "minimum":"0",
            "maximum":"65535",
            "example":"161"
        },
        "MTU":{
            "description":"The MTU for the custom SNMP access profile.",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647",
            "example":"1456"
        },
        "Auth":{
            "$ref":"#/components/schemas/CustomSNMPAccessProfileAuth"
        }
    }
}

Nested Schema : CustomSNMPAccessProfileAuth

Type: object

Custom 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

{
    "description":"Custom SNMP access profile authentication information.",
    "type":"object",
    "properties":{
        "Community":{
            "description":"The custom SNMP access profile community string.",
            "type":"string",
            "example":"public"
        },
        "Username":{
            "description":"The custom SNMP access profile user name.",
            "type":"string",
            "example":"user"
        },
        "AuthType":{
            "description":"The custom SNMP access profile authentication type.",
            "type":"string",
            "enum":[
                "NOAUTHNOPRIV",
                "AUTHNOPRIV",
                "AUTHPRIV"
            ],
            "example":"AUTHPRIV"
        },
        "AuthPassphrase":{
            "description":"The custom SNMP access profile authentication passphrase.",
            "type":"string",
            "example":"QXV0aFBhc3N3b3Jk"
        },
        "AuthProtocol":{
            "description":"The custom SNMP access profile authentication protocol.",
            "type":"string",
            "example":"SHA256"
        },
        "PrivPassphrase":{
            "description":"The custom SNMP access profile private passphrase.",
            "type":"string",
            "example":"UHJpdlBhc3N3b3Jk"
        },
        "PrivProtocol":{
            "description":"The custom SNMP access profile private protocol.",
            "type":"string",
            "example":"AES"
        },
        "AuthEngineID":{
            "description":"The custom SNMP access profile authentication engine ID.",
            "type":"string",
            "example":"80001adc802417e202b8613f5400000000"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DiscoveryCreateResponse

Type: object

Show Source

• DiscoveryContextID: string
  The ID obtained from discovery request.

  Example: disco-01f107bd-655f-42e0-ae1c-ac4740e734e7
• time-valid: integer
  The number of seconds the discovery result is valid.

  Example: 3600

{
    "type":"object",
    "properties":{
        "DiscoveryContextID":{
            "description":"The ID obtained from discovery request.",
            "type":"string",
            "example":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7"
        },
        "time-valid":{
            "description":"The number of seconds the discovery result is valid.",
            "type":"integer",
            "example":"3600"
        }
    }
}

400 Response

Bad request

401 Response

Unauthorized operation

500 Response

Internal server error

Back to Top