Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

The tenant API key that POST /bootstrap returned.

Path Parameters

id
string
required

The upstream ID.

Body

application/json
host
string

Exists only to refuse a change. Any value gets 400.

name
string
Minimum string length: 1
domains
string[]

Replaces the list. An empty list removes every domain. Omit to keep the current list.

port
integer
Required range: 1 <= x <= 65535
transport
enum<string>
Available options:
udp,
tcp
max_expires
integer
Required range: 1 <= x <= 4294967295
invite_source_cidrs
string[]

Replaces the list. An empty list removes every prefix, which an upstream whose host is a DNS name can't have.

strict_path
boolean

Refuse a registration when the PBX's answer doesn't keep pgw's Path. The PBX then never sends calls past pgw.

keepalive_seconds
integer

0 turns the OPTIONS keepalive off; otherwise from 5 to 3600.

contact_strategy
string

Exists only to refuse a change. Any value other than the upstream's gets 400.

mode
string

Exists only to refuse a change. Any value other than the upstream's gets 400.

realm
string

Exists only to refuse a change. Any value other than the upstream's gets 400.

managed_registration
enum<string>

Changes how a managed upstream registers devices at the PBX. An empty string uses the gateway default. Omit to keep the current value.

Available options:
,
per_user,
per_device
user_source
string

Exists only to refuse a change. Any value other than the upstream's gets 400.

kamailio
object

The Kamailio database of an upstream with user_source kamailio. pgw connects to it over TCP and reads its tables before it stores the upstream, and answers 400 with the step that failed. On create, driver, host, user, password, and database are required, and a table or column left out gets Kamailio's own name. On update, each field replaces the stored one. A table or column name is a letter or an underscore, then at most 63 letters, digits, or underscores.

app_auth
enum<string>

Changing to digest drops bearer. Changing to bearer or both needs every bearer field, stored or sent.

Available options:
digest,
bearer,
both
bearer
object

The issuer of the access tokens that apps present, required with app_auth bearer or both and refused with digest. On create, every field is required. On update, each field present replaces the stored one.

Response

The updated upstream.

id
string
required
name
string
required
host
string
required
port
integer
required
transport
enum<string>
required

pgw doesn't connect to PBXs over tls, so registrations to such an upstream fail. Change it to udp or tcp; until then, any other change gets 400.

Available options:
udp,
tcp,
tls
mode
enum<string>
required
Available options:
passthrough,
managed
contact_strategy
enum<string>
required
Available options:
path,
masquerade
max_expires
integer
required
invite_source_cidrs
string[]
required
strict_path
boolean
required
keepalive_seconds
integer
required
managed_registration
enum<string>
required

Empty when the upstream uses the gateway default.

Available options:
,
per_user,
per_device
user_source
enum<string>
required
Available options:
pgw,
kamailio
app_auth
enum<string>
required
Available options:
digest,
bearer,
both
created_at
string<date-time>
required
domains
string[]

The upstream's domains, sorted. Absent when it has none.

realm
string

The digest realm of a managed upstream. Absent when it is the host.

kamailio
object
bearer
object