HTTP Requests

Probe API is a BETA feature, not yet available to all accounts.

Get all Destinations

GET http://[probe ip]:4396/api/destinations

Get all Destinations that are exposed via the APIs assigned ACL

Headers

Name
Type
Description

Authorizaton*

Basic

Basic auth user/password provided by API configuration

{
    "count": 1,
    "data": [
        {
            "id": "bbc74be4-0606-473f-916d-3e13e3864f92",
            "index": 213,
            "name": "TEST ONLY",
            "xpoint": "BB BARS",
            "lock": false,
            "history": null,
            "deviceId": "594d08e5-ff50-4acf-a7da-87f0795d8dfd",
            "probeId": "5a29446d-9955-4df1-97d9-2ae68deaf410",
            "orgId": "40614fce-884e-4b79-ae70-53bd0f93fd96"
        }, 
        { ... }
    ]
}

Get specific Destination

GET http://[probe ip]:4396/destinations/[id]

Path Parameters

Name
Type
Description

id*

String

Destination ID

Headers

Name
Type
Description

Authoriztion*

Basic

Basic auth user/password provided by API configuration

Get all Sources

GET http://[probe ip]:4396/api/sources

Get all Sources that are exposed via the APIs assigned ACL

Headers

Name
Type
Description

Authorization*

Basc

Basic auth user/password provided by API configuration

Get specific Source

GET http://[probe ip]:4396/api/sources/[id]

Path Parameters

Name
Type
Description

id*

String

Source ID

Headers

Name
Type
Description

Authorization*

Basic

Basic auth user/password provided by API configuration

Lock Destination

POST http://[probe ip]:4396/api/lock

Headers

Name
Type
Description

Authorization*

Basic

Basic auth user/password provided by API configuration

Request Body

Name
Type
Description

destination*

object

Destination object to lock

Take Source to Destination

POST http://[probe ip]:4396/api/take

Headers

Name
Type
Description

Authorizaton*

Basic

Basic auth user/password provided by API configuration

Request Body

Name
Type
Description

destination*

object

Destination object (as returned from GET destinations)

source*

object

Source object (as returned from GET sources)

PreviousConfiguration

Last updated

Was this helpful?