Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Administration

Retrieve a transport

Retrieve a transport by it's unique ID.

get/transports/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the transport.

Response

OK

idstring

The unique ID of the resource.

protocol'UDP' | 'TCP' | 'TLS'

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
portinteger

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

verification'DISABLE' | 'OPTIONAL' | 'MANDATORY'

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.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "port": 80
}