Child pages
  • REST Servers
Skip to end of metadata
Go to start of metadata

View REST servers settings

Available in 14 starting with 14.10

Resource URI: /restserver/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 REST servers settings in the system.

Example: XML format

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

<Settings>

<Setting>

<path>rest-config/log.level</path>

<type>enum</type>

<options>

<entry>

<key>NOTICE</key>

</entry>

<entry>

<key>CRIT</key>

</entry>

<entry>

<key>EMERG</key>

</entry>

<entry>

<key>WARNING</key>

</entry>

<entry>

<key>ERR</key>

</entry>

<entry>

<key>INFO</key>

</entry>

<entry>

<key>ALERT</key>

</entry>

<entry>

<key>DEBUG</key>

</entry>

</options>

<value>NOTICE</value>

<defaultValue>NOTICE</defaultValue>

<label>Logging Level</label>

</Setting>

<Setting>

<path>rest-config/sipPort</path>

<type>integer</type>

<value>6050</value>

<defaultValue>6050</defaultValue>

<label>Sip Port</label>

</Setting>

<Setting>

<path>rest-config/httpPort</path>

<type>integer</type>

<value>6667</value>

<defaultValue>6667</defaultValue>

<label>Http Port</label>

</Setting>

<Setting>

<path>rest-config/publicHttpPort</path>

<type>integer</type>

<value>6666</value>

<defaultValue>6666</defaultValue>

<label>Public Http Port</label>

</Setting>

</Settings>

JSON format

{

settings: [4]

0: {

path: "rest-config/log.level"

type: "enum"

options: {

NOTICE: null

CRIT: null

EMERG: null

WARNING: null

ERR: null

INFO: null

ALERT: null

DEBUG: null

}-

value: "NOTICE"

defaultValue: "NOTICE"

label: "Logging Level"

description: null

}-

1: {

path: "rest-config/sipPort"

type: "integer"

options: null

value: "6050"

defaultValue: "6050"

label: "Sip Port"

description: null

}-

2: {

path: "rest-config/httpPort"

type: "integer"

options: null

value: "6667"

defaultValue: "6667"

label: "Http Port"

description: null

}-

3: {

path: "rest-config/publicHttpPort"

type: "integer"

options: null

value: "6666"

defaultValue: "6666"

label: "Public Http Port"

description: null

}-

-

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify REST servers settings

Available in 14 starting with 14.10

Resource URI: /restserver/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 REST servers options for the setting from the specified path.

Example: XML format

<Setting>

<path>rest-config/httpPort</path>

<type>integer</type>

<value>6667</value>

<defaultValue>6667</defaultValue>

<label>Http Port</label>

</Setting>

JSON format

{

path: "rest-config/httpPort"

type: "integer"

options: null

value: "6667"

defaultValue: "6667"

label: "Http Port"

description: null

}

HTTP Method: PUT

Modifies REST servers options options for the setting from the specified path.

HTTP Method: DELETE

Deletes REST servers options options for the setting from the specified path.

Unsupported HTTP Method: POST

  • No labels