API : SBC Host Update

Introduction

This request will update an internal hosts that the SBC relays traffic to and accepts traffic from.

URL	https://api.telecomx.dk/sbc/host/HOST_ID
Method	GET
Access level	ADMIN.
Param	_id	IP address of the host.
Body	hostname	String	Hostname of the host.
	purpose	String	What the host is used for.
	pbxCluster	Number	Id of the PBX cluster the host belongs to.
	serviceMode	Boolean	True if host is down for service (PBX type only).
	type	String	Type of server: gw, trunk, pbx, tngw, sbc, development, webrtc, job.

{
  hostname: 'siptrunk48.telecomx.dk'
}

The response is a host object.

Peer object (JSON)
_id	String	IP address of the host.
hostname	String	Hostname of the host.
purpose	String	What the host is used for.
pbxCluster	Number	Id of the PBX cluster the host belongs to.
serviceMode	Boolean	True if host is down for service (PBX type only).
type	String	Type of server: gw, trunk, pbx, tngw, sbc, development, webrtc, job.

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

{
  _id: '3.1.1.1',
  hostname: 'siptrunk23.telecomx.dk',
  purpose: 'SIP trunk server, part of primary cluster',
  type: 'trunk'
}

{
  _id: '213.83.176.40',
  hostname: 'pbx1.telecomx.dk',
  purpose: 'Hosted PBX',
  pbxCluster: 1,
  serviceMode: false,
  type: 'pbx'
}

Error code	Message	Description
400	bad_request	Id not found in request URI
404	_id	Host not found
422	hostname	Hostname is not valid - it could not be resolved
409	hostname	Hostname does not resolve to the hosts IP address
422	pbxCluster	Invalid PBX cluster id
422	type	Invalid type
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>