API : SBC Host Create

Introduction

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

URL	https://api.telecomx.dk/sbc/host
Method	POST
Access level	ADMIN.
Body	_id	String	IP address of the host.
	hostname	String	Hostname of the host. Must resolve to the host's IP address.
	purpose	String	`[optional]` What the host is used for.
	pbxCluster	Number	Id of the PBX cluster the host belongs to. Required for pbx hosts, a whole number from 1 to 9. Ignored for other types.
	serviceMode	Boolean	`[optional]` True if host is down for service. Only stored for pbx, webrtc and voicemail hosts.
	type	String	Type of server: gw, trunk, pbx, tngw, sbc, development, webrtc, job, voicemail.

{
  "_id": "203.0.113.10",
  "hostname": "siptrunk1.example.com",
  "purpose": "SIP trunk server, part of primary cluster",
  "type": "trunk"
}

{
  "_id": "203.0.113.20",
  "hostname": "pbx1.example.com",
  "purpose": "Hosted PBX",
  "pbxCluster": 1,
  "serviceMode": false,
  "type": "pbx"
}

The response is a host object.

Host 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. Only on pbx hosts.
serviceMode	Boolean	True if host is down for service.
type	String	Type of server: gw, trunk, pbx, tngw, sbc, development, webrtc, job, voicemail.

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

{
  "_id": "203.0.113.10",
  "hostname": "siptrunk1.example.com",
  "purpose": "SIP trunk server, part of primary cluster",
  "type": "trunk"
}

{
  "_id": "203.0.113.20",
  "hostname": "pbx1.example.com",
  "purpose": "Hosted PBX",
  "pbxCluster": 1,
  "serviceMode": false,
  "type": "pbx"
}

Error code	Message	Description
422	<property>	Invalid input for the named property - the request body, query or URL parameter failed validation
422	hostname	Hostname is not valid - it could not be resolved
409	hostname	Hostname does not resolve to the specified IP address
409	_id	A host with the same IP address already exists
422	pbxCluster	Invalid PBX cluster id
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>