Transports

PreviousExport NextDestroy

Was this helpful?

List transports

Retrieve a collection of transports

get

/transports

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/transports' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "protocol": "UDP",
      "verification": "DISABLE",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "port": 80
    }
  ]
}

Create a transport

Add a new transport.

post

/transports

Authorizations

Body

protocolstring · enumrequired

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Options: UDP, TCP, TLS

verificationstring · enum

Indicates if PBX wishes (Optional) or requires (Mandatory) TLS clients to present a client certificate:

DISABLE: disable client certificate.
OPTIONAL: client authentication optional.
MANDATORY: force client authentication.

Options: DISABLE, OPTIONAL, MANDATORY

portall ofrequired

The port of transport.

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/transports' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "protocol": "UDP",
    "verification": "DISABLE",
    "port": 80
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created transport

Retrieve a transport

Retrieve a transport by it's unique ID.

get

/transports/{id}

Authorizations

Path parameters

idstringrequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/transports/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "protocol": "UDP",
  "verification": "DISABLE",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "port": 80
}

Update transport

Update a new transport.

post

/transports/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of transport.

The unique ID of the resource.

Body

verificationstring · enum

Indicates if PBX wishes (Optional) or requires (Mandatory) TLS clients to present a client certificate:

DISABLE: disable client certificate.
OPTIONAL: client authentication optional.
MANDATORY: force client authentication.

Options: DISABLE, OPTIONAL, MANDATORY

portall of

The port of transport.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/transports/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "verification": "DISABLE",
    "port": 80
  }'

200

4XX

No body