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 | POST | ||
| Access level | ADMIN. | ||
| Param | SERVER_ID | Id of the SBC server (IP address). | |
| Body | hostname | String | [optional] Hostname of the SBC server. Must resolve to the server's IP address - an empty value keeps the stored hostname. |
| serviceMode | Boolean | [optional] 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": "203.0.113.12", "hostname": "sbc02.example.com", "serviceMode": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | <property> | Invalid input for the named property - the request body, query or URL parameter failed validation |
| 404 | id | Server not found |
| 422 | hostname | Hostname is not valid - it could not be resolved |
| 409 | hostname | Hostname does not resolve to the specified IP address |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/sbc/server/update.txt · Last modified: by Mikkel Meerwaldt Jørgensen