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

View or add new nodes

Resource URI: /servers

Default Resource Properties:

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

Property

Description

id

Server unique identification number.

host

Name of the host server.

ip

The IP address.

primary

Type of the server. Displays True if it is a primary server or False if it's a not a primary server.

registered

Displays True if it is a registered server or False if it's not.

description

Short description provided by the user.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves all configured nodes.

Example: XML format

<Servers>

<Server>

<id>1</id>

<host>openuc_1410.ezuce.ro</host>

<ip>195.167.1.323</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</Server>

<Server>

<id>2</id>

<host>openuc_1410.ezuce.ro</host>

<ip>192.492.3.850</ip>

<primary>true</primary>

<registered>true</registered>

<description>secondary</description>

</Server>

</Servers>

JSON format

{



servers: [2]



{

primary: true

description: "Primary"

host: "openuc_1410.ezuce.ro"

id: 1

registered: true

ip: "195.167.1.323"

{

primary: false

description: "secondary"

host: "openuc_1410.ezuce.ro"

id: 2

registered: true

ip: "192.492.3.850"

}-

-

}

HTTP Method: POST

Configures a new node.

Unsupported HTTP Method: PUT, DELETE


View or modify nodes for an internal ID

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}

Default Resource Properties:

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

Property

Description

id

Server ID.

host

Name of the host server.

ip

The IP address.

primary

Type of the server. Displays True if it is a primary server or False if it's a not a primary server.

registered

Displays True if it is a registered server or False if it's not.

description

Short description provided by the user.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves nodes for the specified internal ID or host name.

Example: XML format

<Server>

<id>1</id>

<host>openuc_1410.ezuce.ro</host>

<ip>195.167.1.323</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</Server>

JSON format

{

primary: true

description: "Primary"

host: "openuc_1410.ezuce.ro"

id: 1

registered: true

ip: "195.167.1.323"

{

HTTP Method: PUT

Creates a new node node for the specified internal ID or host name.

HTTP Method: DELETE

Deletes the node node for the specified internal ID or host name.

Unsupported HTTP Method: POST


View node features for an internal ID

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}/features

Default Resource Properties:

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

Property

Description

name

Name of the feature.

bundle

Name of the bundle taht contains the feature.

type

Feature type.

enabeled

Displays True if it is a registered server or False if it's not.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves nodes for the specified internal ID or host name.

Example: XML format

<Features>

<features>

<name>reports</name>

<bundle>core</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>dhcpd</name>

<bundle>core</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>sipxdns</name>

<bundle>core</bundle>

<type>location</type>

<enabled>true</enabled>

</features>

<features>

<name>event</name>

<bundle>core</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>freeSwitch</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>authCode</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>recording</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>redis</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>ivr</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>moh</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>park</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>sbcBridge</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>registrar</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>sipxcdr</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>openuc-saa</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>sipxsqa</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>callqueue</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>mwi</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>homer_web</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>page</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>proxy</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>sipxsss</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>restServer</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>conference</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>homer_capture</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>mysql</name>

<bundle>coreTelephony</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>reach</name>

<bundle>callCenter</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>reach-redis</name>

<bundle>callCenter</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>instantMessage</name>

<bundle>im</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>imbot</name>

<bundle>im</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>dhcpd</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>phonelog</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>hoteling</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>ftp</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>true</enabled>

</features>

<features>

<name>provision</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>tftp</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>true</enabled>

</features>

</Features>

JSON format

{



features: [36]



0: {

bundle: "core"

type: "location"

enabled: false

name: "reports"

}-

1: {

bundle: "core"

type: "location"

enabled: false

name: "dhcpd"

}-

2: {

bundle: "core"

type: "location"

enabled: true

name: "sipxdns"

}-

3: {

bundle: "core"

type: "location"

enabled: false

name: "event"

}-

4: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "freeSwitch"

}-

5: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "authCode"

}-

6: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "recording"

}-

7: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "redis"

}-

8: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "ivr"

}-

9: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "moh"

}-

10: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "park"

}-

11: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "sbcBridge"

}-

12: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "registrar"

}-

13: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "sipxcdr"

}-

14: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "openuc-saa"

}-

15: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "sipxsqa"

}-

16: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "callqueue"

}-

17: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "mwi"

}-

18: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "homer_web"

}-

19: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "page"

}-

20: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "proxy"

}-

21: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "sipxsss"

}-

22: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "restServer"

}-

23: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "conference"

}-

24: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "homer_capture"

}-

25: {

bundle: "coreTelephony"

type: "location"

enabled: false

name: "mysql"

}-

26: {

bundle: "callCenter"

type: "location"

enabled: false

name: "reach"

}-

27: {

bundle: "callCenter"

type: "location"

enabled: false

name: "reach-redis"

}-

28: {

bundle: "im"

type: "location"

enabled: false

name: "instantMessage"

}-

29: {

bundle: "im"

type: "location"

enabled: false

name: "imbot"

}-

30: {

bundle: "provision"

type: "location"

enabled: false

name: "dhcpd"

}-

31: {

bundle: "provision"

type: "location"

enabled: false

name: "phonelog"

}-

32: {

bundle: "provision"

type: "location"

enabled: false

name: "hoteling"

}-

33: {

bundle: "provision"

type: "location"

enabled: true

name: "ftp"

}-

34: {

bundle: "provision"

type: "location"

enabled: false

name: "provision"

}-

35: {

bundle: "provision"

type: "location"

enabled: true

name: "tftp"

}-

-

}

Unsupported HTTP Method: POST, PUT, DELETE


Enable/disable the location feature

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}/features/{featureId}

Default Resource Properties: N/A

Specific Response Codes: N/A

HTTP Method: DELETE

Disable location based feature for the specified node.

HTTP Method: POST

Enable location based feature for the specified node.

Unsupported HTTP Method: GET, POST


View or delete jobs on all servers

Available in 14 starting with 14.10

Resource URI: /servers/jobs

Default Resource Properties:

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

Property

Description

name

Job name.

status

Job status. Possible values are: Completed or Failed.

start

Start date of the job.

end

End date of the job.

server

The server related information is similar to the one described under /servers/{serverId}.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve jobs on all servers.

Example: XML format

<Jobs>

<Job>

<name>Configuration deployment</name>

<status>COMPLETED</status>

<start>9/8/14 12:34 PM</start>

<end>9/8/14 12:34 PM</end>

<server>

<id>1</id>

<host>o14_10.ezuce.ro</host>

<ip>192.234.3.788</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</server>

<errMsg />

</Job>

<Job>

<name>Configuration generation</name>

<status>COMPLETED</status>

<start>9/8/14 12:36 PM</start>

<end>9/8/14 12:36 PM</end>

<errMsg />

</Job>

<Job>

<name>Configuration deployment</name>

<status>FAILED</status>

<start>9/8/14 12:36 PM</start>

<end>9/8/14 12:36 PM</end>

<server>

<id>1</id>

<host>o14_10.ezuce.ro</host>

<ip>152.667.1.141</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</server>

<errMsg />

</Job>

</Jobs>

JSON format

{



jobs: [3]



0: {

errMsg: ""

server: {

primary: true

description: "Primary"

host: "o14_10.ezuce.ro"

id: 1

registered: true

ip: "192.234.3.788"

}-

status: "COMPLETED"

start: "9/8/14 12:34 PM"

end: "9/8/14 12:34 PM"

name: "Configuration deployment"

}-

1: {

errMsg: ""

server: null

status: "COMPLETED"

start: "9/8/14 12:36 PM"

end: "9/8/14 12:36 PM"

name: "Configuration generation"

}-

2: {

errMsg: ""

server: {

primary: true

description: "Primary"

host: "o14_10.ezuce.ro"

id: 1

registered: true

ip: "152.667.1.141"

}-

status: "FAILED"

start: "9/8/14 12:36 PM"

end: "9/8/14 12:36 PM"

name: "Configuration deployment"

}-

-

}

HTTP Method: DELETE

Delete jobs on all servers.

Unsupported HTTP Method: POST, PUT


View or delete completed jobs on all servers

Available in 14 starting with 14.10

Resource URI: /servers/jobs/completed

Default Resource Properties:

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

Property

Description

job

The jobs related information is similar to the one described under /servers/jobs.

server

The server related information is similar to the one described under /servers/{serverId}.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve completed jobs on all servers.

Example: XML format

<Jobs>

<Job>

<name>Configuration deployment</name>

<status>COMPLETED</status>

<start>9/8/14 12:34 PM</start>

<end>9/8/14 12:34 PM</end>

<server>

<id>1</id>

<host>o14_10.ezuce.ro</host>

<ip>192.234.3.788</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</server>

<errMsg />

</Job>

<Job>

<name>Configuration generation</name>

<status>COMPLETED</status>

<start>9/8/14 12:36 PM</start>

<end>9/8/14 12:36 PM</end>

<errMsg />

</Job>

<Job>

</Jobs>

JSON format

{

errMsg: ""

server: {

primary: true

description: "Primary"

host: "o14_10.ezuce.ro"

id: 1

registered: true

ip: "152.667.1.141"

}-

status: "FAILED"

start: "9/8/14 12:36 PM"

end: "9/8/14 12:36 PM"

name: "Configuration deployment"

}-

-

}

HTTP Method: DELETE

Delete completed jobs on all servers.

Unsupported HTTP Method: POST, PUT


View or delete failed jobs on all servers

Available in 14 starting with 14.10

Resource URI: /servers/jobs/failed

Default Resource Properties:

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

Property

Description

job

The jobs related information is similar to the one described under /servers/jobs.

server

The server related information is similar to the one described under /servers/{serverId}.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve failed jobs on all servers.

Example: XML format

<jobs>

<Job>

<name>Configuration deployment</name>

<status>FAILED</status>

<start>9/8/14 12:36 PM</start>

<end>9/8/14 12:36 PM</end>

<server>

<id>1</id>

<host>o14_10.ezuce.ro</host>

<ip>152.667.1.141</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</server>

<errMsg />

</Job>

</Jobs>

JSON format

{



jobs: [1]



0: {

errMsg: ""

server: {

primary: true

description: "Primary"

host: "o14_10.ezuce.ro"

id: 1

registered: true

ip: "192.234.3.788"

}-

]

HTTP Method: DELETE

Delete failed jobs on all servers.

Unsupported HTTP Method: POST, PUT


View or delete jobs on an internal ID

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}/jobs

Default Resource Properties:

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

Property

Description

job

The jobs related information is similar to the one described under /servers/jobs.

server

The server related information is similar to the one described under /servers/{serverId}.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve jobs on the specified internal ID or host name.

Example: XML format

<Jobs>

<Job>

<name>IMDB regeneration</name>

<status>COMPLETED</status>

<start>10/13/14 1:31 PM</start>

<end>10/13/14 1:31PM</end>

<server><id>1</id>

<host>openuc-14-10.example.com</host>

<ip>192.168.7.110</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</server><errMsg></errMsg>

</Job>

</Jobs>

JSON format

{

"Jobs": {

"Job": {

"name": "IMDB regeneration",

"status": "COMPLETED",

"start": "10/13/14 1:31 PM",

"end": "10/13/14 1:31PM",

"server": {

"id": "1",

"host": "openuc-14-10.example.com",

"ip": "192.168.7.110",

"primary": "true",

"registered": "true",

"description": "Primary"

}

}

}

}

HTTP Method: DELETE

Delete jobs on the specified internal ID or host name.

Unsupported HTTP Method: POST, PUT


View or delete completed jobs on an internal ID

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}/jobs/completed

Default Resource Properties:

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

Property

Description

job

The jobs related information is similar to the one described under /servers/jobs.

server

The server related information is similar to the one described under /servers/{serverId}.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve completed jobs on the specified internal ID or host name.

Example: XML format


JSON format


HTTP Method: DELETE

Delete completed jobs on the specified internal ID or host name.

Unsupported HTTP Method: POST, PUT


View or delete failed jobs on an internal ID

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}/jobs/failed

Default Resource Properties: N/A

Specific Response Codes: N/A

HTTP Method: GET

Retrieve failed jobs on the specified internal ID or host name.

HTTP Method: DELETE

Delete failed jobs on the specified internal ID or host name.

Unsupported HTTP Method: POST, PUT


View all bundles

Available in 14 starting with 14.10

Resource URI: /servers/bundles

Default Resource Properties:

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

Property

Description

name

Bundle name.

globalFeature

List of global features.

locationFeature

List of location features.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve bundles.

Example: XML format

<Bundles>

<Bundle>

<name>core</name>

<GlobalFeatures>

<Feature>snmp</Feature>

<Feature>sipxlogwatcher</Feature>

<Feature>mail</Feature>

<Feature>firewall</Feature>

<Feature>ntpd</Feature>

<Feature>fail2ban</Feature>

<Feature>alarms</Feature>

</GlobalFeatures>

<LocationFeatures>

<Feature>reports</Feature>

<Feature>dhcpd</Feature>

<Feature>sipxdns</Feature>

<Feature>event</Feature>

</LocationFeatures>

</Bundle>

<Bundle>

<name>coreTelephony</name>

<GlobalFeatures>

<Feature>intercom</Feature>

</GlobalFeatures>

<LocationFeatures>

<Feature>freeSwitch</Feature>

<Feature>authCode</Feature>

<Feature>recording</Feature>

<Feature>redis</Feature>

<Feature>ivr</Feature>

<Feature>moh</Feature>

<Feature>park</Feature>

<Feature>sbcBridge</Feature>

<Feature>registrar</Feature>

<Feature>sipxcdr</Feature>

<Feature>openuc-saa</Feature>

<Feature>sipxsqa</Feature>

<Feature>callqueue</Feature>

<Feature>mwi</Feature>

<Feature>homer_web</Feature>

<Feature>page</Feature>

<Feature>proxy</Feature>

<Feature>sipxsss</Feature>

<Feature>restServer</Feature>

<Feature>conference</Feature>

<Feature>homer_capture</Feature>

<Feature>mysql</Feature>

</LocationFeatures>

</Bundle>

<Bundle>

<name>callCenter</name>

<GlobalFeatures />

<LocationFeatures>

<Feature>reach</Feature>

<Feature>reach-redis</Feature>

</LocationFeatures>

</Bundle>

<Bundle>

<name>im</name>

<GlobalFeatures />

<LocationFeatures>

<Feature>instantMessage</Feature>

<Feature>imbot</Feature>

</LocationFeatures>

</Bundle>

<Bundle>

<name>provision</name>

<GlobalFeatures />

<LocationFeatures>

<Feature>dhcpd</Feature>

<Feature>phonelog</Feature>

<Feature>hoteling</Feature>

<Feature>ftp</Feature>

<Feature>provision</Feature>

<Feature>tftp</Feature>

</LocationFeatures>

</Bundle>

<Bundle>

<name>experimental</name>

<GlobalFeatures />

<LocationFeatures />

</Bundle>

</Bundles>

JSON format

{



bundles: [6]



0: {



locationFeatures: [4]



0: "reports"

1: "dhcpd"

2: "sipxdns"

3: "event"

-



globalFeatures: [7]



0: "snmp"

1: "sipxlogwatcher"

2: "mail"

3: "firewall"

4: "ntpd"

5: "fail2ban"

6: "alarms"

-

name: "core"

}-

1: {



locationFeatures: [22]



0: "freeSwitch"

1: "authCode"

2: "recording"

3: "redis"

4: "ivr"

5: "moh"

6: "park"

7: "sbcBridge"

8: "registrar"

9: "sipxcdr"

10: "openuc-saa"

11: "sipxsqa"

12: "callqueue"

13: "mwi"

14: "homer_web"

15: "page"

16: "proxy"

17: "sipxsss"

18: "restServer"

19: "conference"

20: "homer_capture"

21: "mysql"

-



globalFeatures: [1]



0: "intercom"

-

name: "coreTelephony"

}-

2: {



locationFeatures: [2]



0: "reach"

1: "reach-redis"

-



globalFeatures: [0]



name: "callCenter"

}-

3: {



locationFeatures: [2]



0: "instantMessage"

1: "imbot"

-



globalFeatures: [0]



name: "im"

}-

4: {



locationFeatures: [6]



0: "dhcpd"

1: "phonelog"

2: "hoteling"

3: "ftp"

4: "provision"

5: "tftp"

-



globalFeatures: [0]



name: "provision"

}-

5: {



locationFeatures: [0]





globalFeatures: [0]



name: "experimental"

}-

-

}

HTTP Method: DELETE

Delete bundles.

Unsupported HTTP Method: POST, PUT


View features for a bundle ID

Available in 14 starting with 14.10

Resource URI: /servers/bundles/{bundleId}

Default Resource Properties:

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

Property

Description

name

Bundle name.

globalFeature

List of global features.

locationFeature

List of location features.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve bundles on the specified bundle ID.

Example: XML format

<Bundle>

<name>im</name>

<GlobalFeatures />

<LocationFeatures>

<Feature>instantMessage</Feature>

<Feature>imbot</Feature>

</LocationFeatures>

</Bundle>

JSON format

{



locationFeatures: [2]



0: "instantMessage"

1: "imbot"

-



globalFeatures: [0]



name: "im"

}

HTTP Method: DELETE

Delete bundles on the specified bundle ID.

Unsupported HTTP Method: POST, PUT


View global features

Available in 14 starting with 14.10

Resource URI: /servers/features

Default Resource Properties:

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

Property

Description

name

Feature name.

bundle

The bundle containig the feature.

type

Feature type.

enabled

The status of the feature. Displays True if it is enabled or False if it is disabled.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves list of all global features.

Example: XML format

<Features>

<features>

<name>snmp</name>

<bundle>core</bundle>

<type>global</type>

<enabled>true</enabled>

</features>

<features>

<name>sipxlogwatcher</name>

<bundle>core</bundle>

<type>global</type>

<enabled>true</enabled>

</features>

<features>

<name>reports</name>

<bundle>core</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>mail</name>

<bundle>core</bundle>

<type>global</type>

<enabled>true</enabled>

</features>

<features>

<name>dhcpd</name>

<bundle>core</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>provision</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>false</enabled>

</features>

<features>

<name>tftp</name>

<bundle>provision</bundle>

<type>location</type>

<enabled>true</enabled>

</features>

</Features>

JSON format

{



features: [44]



0: {

bundle: "core"

type: "global"

enabled: true

name: "snmp"

}-

{

bundle: "core"

type: "global"

enabled: true

name: "sipxlogwatcher"

}-

{

bundle: "core"

type: "location"

enabled: false

name: "reports"

}-

{

bundle: "core"

type: "global"

enabled: true

name: "mail"

}-

{

bundle: "core"

type: "location"

enabled: false

name: "dhcpd"

}-

{

bundle: "core"

type: "global"

enabled: true

name: "firewall"

}

{

bundle: "provision"

type: "location"

enabled: false

name: "provision"

}-

{

bundle: "provision"

type: "location"

enabled: true

name: "tftp"

}-

-

}

Unsupported HTTP Method: POST, PUT, DELETE


Delete or modify a global feature

Available in 14 starting with 14.10

Resource URI: /servers/features/{featureId}

Default Resource Properties: N/A

Specific Response Codes: N/A

HTTP Method: DELETE

Disables the global feature with the specified ID.

HTTP Method: POST

Enables the global feature with the specified ID.

Unsupported HTTP Method: GET, POST


View or delete features for a server ID

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}

Default Resource Properties:

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

Property

Description

id

Unique identification number of the server.

host

Server host.

ip

IP address.

primary

Displays True if the server is primary or False if it is not.

registered

Displays True if the server is registered or False if it is not.

description

Short description provided by the user.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve all the features for the specified ID.

Example: XML format

<Server>

<id>1</id>

<host>openuc14_10.ezuce.ro</host>

<ip>195.168.5.171</ip>

<primary>true</primary>

<registered>true</registered>

<description>Primary</description>

</Server>

JSON format

{

host: "openuc14_10.ezuce.ro"

id: 1

description: "Primary"

primary: true

registered: true

ip: "195.168.5.171"

}

HTTP Method: DELETE

Delete all the features for the specified ID.

Unsupported HTTP Method: POST, PUT


Enable or disable location for a server ID

Available in 14 starting with 14.10

Resource URI: /servers/{serverId}/features/{featureId}

Default Resource Properties:

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

Property

Description

name

Feature name.

bundle

The bundle containig the feature.

type

Feature type.

enabled

The status of the feature. Displays True if it is enabled or False if it is disabled.

Specific Response Codes: N/A

HTTP Method: GET

Enables the feature with the specified ID.

Example: XML format

<feature>

<name>reports</name>

<bundle>core</bundle>

<type>location</type>

<enabled>false</enabled>

</feature>

JSON format

{

feature

{

bundle: "core"

type: "location"

enabled: false

name: "reports"

}

}

HTTP Method: DELETE

Disables the feature with the specified ID.

Unsupported HTTP Method: POST, PUT


View or modify settings

Available in 14 starting with 14.10

Resource URI: /servers/setting/{pathToService}

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

Retrieve the settings from the specified setting path.

HTTP Method: PUT

Modify the setting from the specified setting path.

HTTP Method: DELETE

Delete the setting from the specified setting path.

Unsupported HTTP Method: POST, PUT


  • No labels