System Domains¶

Retrieve the list of assigned domains¶

GET /api/v1/system/domains/¶

Get the list of assigned domains to the system along with system’s default domain.

Authorization Right: Minimum End User.

Example request:

GET /api/v1/system/domains/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "defaultDomain": "netaxis.sip.be",
   "domains": [
      "netaxis.sip.be",
      "customer.com"
   ]
}

Response JSON Object:

defaultDomain (string) – The default domain name assigned to the system.
domains (array) – The list of domain names assigned to the system.

Status Codes:

200 OK – no error

Add a new domain¶

POST /api/v1/system/domains/¶

Add a new domain to the system.

Authorization Right: Minimum System Admin.

Example request:

POST /api/v1/system/domains/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "domain": "netaxis.be"
}

Request JSON Object:

domain (string) – (Required) A domain name to assign to the system.

Example response:

HTTP/1.1 201 Created
Content-Type: "application/json"

{}

Status Codes:

201 Created – no error
400 Bad Request – failed to create

Remove an existing domain¶

DELETE /api/v1/system/domains/¶

Remove an existing domain from the system.

Authorization Right: Minimum System Admin.

Example request:

DELETE /api/v1/system/domains/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "domain": "netaxis.be"
}

Request JSON Object:

domains (string) – (Required) The domain name to delete from the system.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{}

Status Codes:

200 OK – no error