Transports

List transports

get

Retrieve a collection of transports

Authorizations
Query parameters
filterstringOptional

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

searchstringOptional

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

orderbystringOptional

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

skipinteger · int32Optional

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

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

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

Default: 100
Responses
200
OK
application/json
get
GET /api/transports HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a transport

post

Add a new transport.

Authorizations
Body
protocolstring · enumRequired

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
Possible values:
portall ofRequired

The port of transport.

integer · int32 · max: 65535Optional

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

Example: 80
verificationstring · enumOptional

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.
Possible values:
Responses
201
Created transport
application/json
post
POST /api/transports HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

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

Retrieve a transport

get

Retrieve a transport by it's unique ID.

Authorizations
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/transports/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update transport

post

Update a new transport.

Authorizations
Path parameters
idall ofRequired

The unique ID of transport.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
portall ofOptional

The port of transport.

integer · int32 · max: 65535Optional

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

Example: 80
verificationstring · enumOptional

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.
Possible values:
Responses
200
OK
post
POST /api/transports/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "port": 80,
  "verification": "DISABLE"
}
No content
PreviousExportNextDestroy