API : SBC Peer Host Down Set

Introduction

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

This is used to mark a single host on a peer as down (does not work) or up (works again). When a peer host is marked as down, no outbound calls will be routed to that peer host.

Request

URL	https://api.telecomx.dk/sbc/peer/PEER_ID/host/HOST_IP
Method	POST
Access level	ADMIN.
Param	peer	Id of the peer, e.g. 'Telenor'.
	host	IP address of the host to check.
Body	down	True to mark peer host as down, false to mark it as up.

Query examples

{
  down: true
}

Response

The response is the state of the peer host after the update

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>

WIKI

Table of Contents