Transports

List transports

Retrieve a collection of transports

GEThttp://127.0.0.1:8888/api/transports

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/transports', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a transport

Add a new transport.

POSThttp://127.0.0.1:8888/api/transports

Body

application/json

protocol*enum

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

UDPTCPTLS

port*all of

The port of transport.

verificationenum

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.

DISABLEOPTIONALMANDATORY

Response

2014XX

Created transport

Body

application/json

idall of

The unique ID of transport.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/transports', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "protocol": "UDP",
      "port": {}
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a transport

Retrieve a transport by it's unique ID.

GEThttp://127.0.0.1:8888/api/transports/{id}

Path parameters

id*string

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Response

2004XX

OK

Body

application/json

idall of

The unique ID of transport.

protocolenum

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

UDPTCPTLS

portall of

The port of transport.

verificationenum

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.

DISABLEOPTIONALMANDATORY

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/transports/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update transport

Update a new transport.

POSThttp://127.0.0.1:8888/api/transports/{id}

Path parameters

id*all of

The unique ID of transport.

Body

application/json

portall of

The port of transport.

verificationenum

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.

DISABLEOPTIONALMANDATORY

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/transports/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();