Table of Contents

API : SBC Peer Host Down Get

Introduction

This request will return the state of a single peer host (that the SBC exchanges traffic with).

This is used to see if that host has been marked as down and will not receive outbound calls.

Request

URL https://api.telecomx.dk/sbc/peer/PEER_ID/host/HOST_IP
Method GET
Access level RESELLER_ADMIN with TELE feature, or ADMIN.
Param peer Id of the peer, e.g. 'Telenor'.
host IP address of the host to check.

Query examples

https://api.telecomx.dk/sbc/peer/TELENOR/host/1.2.3.4

Response

JSON object
peer String Id of the peer, e.g. 'TELENOR'.
host String Ip address of the host.
down Boolean True if the host is marked as down.

Response example

{
  _id: 'TELENOR',
  host: '1.2.3.4',
  down: true
}

Errors

Error code Message Description
400 bad_request Id not found in request URI
400 bad_request Host not found in request URI
404 host Host not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>