User Tools

Site Tools


api:sbc:server:create

API : SBC Server Create

Introduction

This request will create an SBC server.

Request

URL https://api.telecomx.dk/sbc/server
Method POST
Access level ADMIN.
Body _id String IP address of the SBC server.
hostname String Hostname of the SBC server. Must resolve to the server's IP address.
serviceMode Boolean [optional] True if the SBC server is in service mode and does not accept new calls to handle.

Query examples

{
  "_id": "203.0.113.12",
  "hostname": "sbc02.example.com",
  "serviceMode": false
}

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": false
}

Errors

Error code Message Description
422 <property> Invalid input for the named property - the request body, query or URL parameter failed validation
422 hostname Hostname is not valid - it could not be resolved
409 hostname Hostname does not resolve to the specified IP address
409 _id A server with the same IP address already exists
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/sbc/server/create.txt · Last modified: by Mikkel Meerwaldt Jørgensen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki