Table of Contents

API : SBC Server Get

Introduction

This request will return an SBC server.

Request

URL https://api.telecomx.dk/sbc/server/SERVER_ID
Method GET
Access level RESELLER_ADMIN with TELE feature, or ADMIN.
Param SERVER_ID Id of the server (IP address).

Query examples

https://api.telecomx.dk/sbc/server/203.0.113.12

Response

The response is an SBC server object, or null when no server has that IP address.

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.

Note that properties holding no value may be omitted from the object.

Response example

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

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>