View registrar settings

Available in 14 starting with 14.10

Resource URI: /registrar/settings

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves a list with all the registrars' settings in the system.

Example: XML format

<Settings>

<Setting>

<path>registrar-config/SIP_REGISTRAR_TCP_PORT</path>

<type>integer</type>

<value>5070</value>

<defaultValue>5070</defaultValue>

<label>TCP Port</label>

<description />

</Setting>

<Setting>

<path>registrar-config/SIP_REGISTRAR_UDP_PORT</path>

<type>integer</type>

<value>5070</value>

<defaultValue>5070</defaultValue>

<label>UDP Port</label>

<description />

</Setting>

<Setting>

<path>registrar-config/SIP_REGISTRAR_REG_EVENT_PORT</path>

<type>integer</type>

<value>5075</value>

<defaultValue>5075</defaultValue>

<label>Registrar Event Port</label>

<description />

</Setting>

<Setting>

<path>registrar-config/SIP_REGISTRAR_XMLRPC_PORT</path>

<type>integer</type>

<value>5077</value>

<defaultValue>5077</defaultValue>

<label>XMLRPC Port</label>

<description />

</Setting>

<Setting>

<path>registrar-config/_SIP_REGISTRAR_PRESENCE_PORT</path>

<type>integer</type>

<value>9096</value>

<defaultValue>9096</defaultValue>

<label>Presence Port</label>

<description />

</Setting>

<Setting>

<path>resource-limits/core-enabled</path>

<type>boolean</type>

<value>false</value>

<defaultValue>false</defaultValue>

<label>Core Enabled</label>

<description>Core Enabled resource limit</description>

</Setting>

</Settings>

JSON format

{

settings: [35]

0: {

path: "registrar-config/SIP_REGISTRAR_TCP_PORT"

type: "integer"

options: null

value: "5070"

defaultValue: "5070"

label: "TCP Port"

description: ""

}-

1: {

path: "registrar-config/SIP_REGISTRAR_UDP_PORT"

type: "integer"

options: null

value: "5070"

defaultValue: "5070"

label: "UDP Port"

description: ""

}-

2: {

path: "registrar-config/SIP_REGISTRAR_REG_EVENT_PORT"

type: "integer"

options: null

value: "5075"

defaultValue: "5075"

label: "Registrar Event Port"

description: ""

}-

3: {

path: "registrar-config/SIP_REGISTRAR_XMLRPC_PORT"

type: "integer"

options: null

value: "5077"

defaultValue: "5077"

label: "XMLRPC Port"

description: ""

}-

4: {

path: "registrar-config/_SIP_REGISTRAR_PRESENCE_PORT"

type: "integer"

options: null

value: "9096"

defaultValue: "9096"

label: "Presence Port"

description: ""

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify registrar settings

Available in 14 starting with 14.10

Resource URI: /registrar/settings/{settingPath}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves registrars' options for the setting from the specified path.

Example: XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<Setting>

<path>other/SIPX_SEND_TRYING_FOR_NIST</path>

<type>boolean</type>

<value>true</value>

<defaultValue>true</defaultValue>

<label>Send 'Trying' response on registrations</label>

<description>By sending a SIP '100 Trying' response on registrations phones will continue to wait. In HA enviroments you'd prefer phones try another proxy and so you might prefer to disable this.</description>

</Setting>

JSON format

{

path: "other/SIPX_SEND_TRYING_FOR_NIST"

type: "boolean"

options: null

value: "true"

defaultValue: "true"

label: "Send 'Trying' response on registrations"

description: "By sending a SIP '100 Trying' response on registrations phones will continue to wait. In HA enviroments you'd prefer phones try another proxy and so you might prefer to disable this."

}

HTTP Method: PUT

Modifies registrars' options options for the setting from the specified path.

HTTP Method: DELETE

Deletes registrars' options options for the setting from the specified path.

Unsupported HTTP Method: POST