Sbc

Retrieve SBC configuration

get

Retrieve settings for SBC.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

domainstringOptional

The SBC domain.

http_portall ofOptional

The SBC web port for http.

Default: 8882

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

https_portall ofOptional

The SBC web port fot https.

Default: 8883

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

4XX

Error

get

/sbc

HTTPcURLJavaScriptPython

GET /api/sbc HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "domain": "text",
  "http_port": 8882,
  "https_port": 8883,
  "transports": [
    {
      "protocol": "UDP",
      "port": 80
    }
  ]
}

Update SBC configuration

post

Update SBC configuration.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

domainstringOptional

The SBC domain.

http_portall ofOptional

The SBC web port for http.

Default: 8882

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

https_portall ofOptional

The SBC web port fot https.

Default: 8883

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

Responses

200

OK

No content

4XX

Error

post

/sbc

HTTPcURLJavaScriptPython

POST /api/sbc HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "domain": "text",
  "http_port": 8882,
  "https_port": 8883,
  "transports": [
    {
      "protocol": "UDP",
      "port": 80
    }
  ]
}

No content