Table of Contents

API : SBC Peers List

Introduction

This request will return a list of all the peers that the SBC exchanges traffic with.

Request

URL https://api.telecomx.dk/sbc/peer
Method GET
Access level RESELLER_ADMIN or ADMIN.

Query examples

https://api.telecomx.dk/sbc/peer

Response

The response is an array of peers.

Peer object (JSON)
_id String Id of the peer, e.g. 'TELENOR'.
default Boolean True if this is the peer that traffic is sent to by default.
name String Friendly name of the peer.
hosts Array Array of IP addresses that the peer exchanges traffic with.
hosts[].host String IP address of the peer host.
hosts[].state String State of the host: up, down, true (unreachable)
failoverPeerId String Id of the peer that calls should be sent through if this peer is down.
networkInterface String Name of the network interface this peer is located on, e.g. ETH0.
up Boolean True if peer is up and usable, false if it is down and the failover should be used instead.

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

Response example

[
  {
    "_id": "Telenor",
    "default": true,
    "name": "Telenor Denmark A/S",
    "hosts": [
      {
        "host": "203.0.113.1",
        "state": "up"
      },
      {
        "host": "203.0.113.2",
        "state": "up"
      },
      {
        "host": "203.0.113.3",
        "state": "up"
      },
      {
        "host": "203.0.113.4",
        "state": "up"
      }
    ],
    "failoverPeerId": "TDC",
    "networkInterface": "ETH0",
    "up": true
  }
]

Errors

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