api:sbc:server:update
Table of Contents
API : SBC Server Update
Introduction
This request will update an SBC server.
Request
| URL | https://api.telecomx.dk/sbc/server/SERVER_ID | ||
|---|---|---|---|
| Method | GET | ||
| Access level | ADMIN. | ||
| Param | SERVER_ID | Id of the SBC server (IP address). | |
| Body | hostname | String | Hostname of the SBC server. |
| serviceMode | Boolean | True if the SBC server is in service mode and does not accept new calls to handle. | |
Query examples
{
serviceMode: true
}
Response
The response is an SBC server object.
| SBC Server object (JSON) | ||
|---|---|---|
| _id | String | IP address of the SBC server. |
| hostname | String | Hostname of the SBC server. |
| serviceMode | Boolean | True if the SBC server is in service mode and does not accept new calls to handle. |
Response example
{ _id: '2.1.1.3', hostname: 'sbc03.telecomx.dk', serviceMode: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Id not found in request URI |
| 404 | id | Server not found |
| 422 | hostname | Hostname is not valid - it could not be resolved |
| 409 | hostname | Hostname doe snot resolve to the specified IP address |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/sbc/server/update.txt · Last modified: 2014/06/06 11:22 by Per Møller