API : SBC Peer Create

Introduction

This request will create a peer that the SBC exchanges traffic with.

Request

URL	https://api.telecomx.dk/sbc/peer
Method	POST
Access level	ADMIN.
Body	_id	String	Id of the peer, e.g. 'Telenor'.
	default	Boolean	`[optional]` 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	`[optional]` Id of the peer that calls should be sent through if this peer is down. Must be an existing peer.
	networkInterface	String	Name of the network interface this peer is located on, e.g. ETH0.
	up	Boolean	`[optional]` True if peer is up and usable, false if it is down and the failover should be used instead.

Query examples

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

Response

The response is a peer object.

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"
    }
  ],
  "failoverPeerId": "TDC",
  "networkInterface": "ETH0",
  "up": true
}

Errors

Error code	Message	Description
422	<property>	Invalid input for the named property - the request body, query or URL parameter failed validation
404	<property>	A required property is missing from the request
404	failoverPeerId	Failover peer not found
409	_id	A peer with the same id already exists
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : SBC Peer Create

Introduction

Request

Query examples

Response

Response example

Errors