Network

Retrieve network configurations

get

Get network configurations.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/network

HTTPcURLJavaScriptPython

GET /api/network HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "web_domain": "text",
  "private_ipv4": "text",
  "public_ipv4": "text",
  "enable_ipv6": true,
  "private_ipv6": "text",
  "public_ipv6": "text",
  "primary_dns_server": "text",
  "secondary_dns_server": "text"
}

Update network configurations

post

Update network configurations for PortSIP PBX.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

web_domainstringOptional

The web domain for PortSIP PBX

private_ipv4stringOptional

The private IPv4 of system.

public_ipv4stringOptional

The public IPv4 of system.

enable_ipv6booleanOptional

Indicates if IPv6 would be enabled.

Default: true

private_ipv6stringOptional

The private IPv6 of system.

public_ipv6stringOptional

The public IPv6 of system.

primary_dns_serverstringOptional

The primary DNS server.

secondary_dns_serverstringOptional

The secondary DNS server.

Responses

200

OK

No content

4XX

Error

post

/network

HTTPcURLJavaScriptPython

POST /api/network HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "web_domain": "text",
  "private_ipv4": "text",
  "public_ipv4": "text",
  "enable_ipv6": true,
  "private_ipv6": "text",
  "public_ipv6": "text",
  "primary_dns_server": "text",
  "secondary_dns_server": "text"
}

No content