IP Access Control Lists

The IP Access Control Lists API lets you create and manage IP address whitelists for authenticating outbound SIP trunks.

API Endpoint

https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/

The IP Access Control List Object

An IP Access Control List (IP ACL) contains a set of whitelisted IP addresses that can send SIP traffic to your outbound trunk.

Attributes

ipacl_uuid

string

Unique identifier for the IP ACL.

name

string

Friendly name for the IP ACL.

ip_addresses

array

List of whitelisted IP addresses.

Example Object

{
  "ipacl_uuid": "f19c4773-4ae6-4b75-92ea-9cf3ea4227d6",
  "name": "production-servers",
  "ip_addresses": [
    "192.168.1.1",
    "192.168.1.2"
  ]
}

List All IP Access Control Lists

Get all IP ACLs for your account.

HTTP Request

GET https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/

Query Parameters

Parameter	Type	Required	Default	Description
`limit`	integer	No	20	Results per page (1-20)
`offset`	integer	No	0	Pagination offset

Response

api_id

string

Unique identifier for the API request.

Example

cURL

curl -i --user AUTH_ID:AUTH_TOKEN \
    https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/

Retrieve an IP Access Control List

Get details of a specific IP ACL.

HTTP Request

GET https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/{ipacl_uuid}/

Response

ipacl_uuid

string

Unique identifier for the IP ACL.

name

string

Friendly name for the IP ACL.

ip_addresses

array

List of whitelisted IP addresses.

{
  "ipacl_uuid": "f19c4773-4ae6-4b75-92ea-9cf3ea4227d6",
  "name": "production-servers",
  "ip_addresses": [
    "192.168.1.1",
    "192.168.1.2"
  ]
}

Example

cURL

curl -i --user AUTH_ID:AUTH_TOKEN \
    https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/f19c4773-4ae6-4b75-92ea-9cf3ea4227d6/

Create an IP Access Control List

Create a new IP whitelist for SIP trunk authentication.

HTTP Request

POST https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/

Request Parameters

Parameter	Type	Required	Default	Description
`name`	string	No	-	Friendly name for the IP ACL
`ip_addresses`	array	Yes	-	Array of IP addresses to whitelist

Response

api_id

string

Unique identifier for the API request.

message

string

Status of the request. Returns IP access control list created successfully. on a successful creation.

ipacl_uuid

string

Unique identifier for the IP ACL.

{
  "api_id": "4e1f954c-baf3-11ec-bafe-0242ac110003",
  "message": "IP access control list created successfully.",
  "ipacl_uuid": "f19c4773-4ae6-4b75-92ea-9cf3ea4227d6"
}

Error Codes

Code	Description
400	Invalid request parameters
401	Authentication failed
422	Missing required parameters (ip_addresses)

Example

cURL

curl -i --user AUTH_ID:AUTH_TOKEN \
    -H "Content-Type: application/json" \
    -d '{
      "name": "production-servers",
      "ip_addresses": ["192.168.0.1", "192.168.0.2", "10.0.0.1"]
    }' \
    https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/

Update an IP Access Control List

Modify an existing IP ACL’s name or IP addresses.

HTTP Request

POST https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/{ipacl_uuid}/

Request Parameters

Parameter	Type	Required	Default	Description
`name`	string	No	-	New friendly name
`ip_addresses`	array	No	-	New list of IP addresses (replaces existing)

Response

api_id

string

Unique identifier for the API request.

message

string

Status of the request. Returns IP access control list updated successfully. on a successful update.

ipacl_uuid

string

Unique identifier for the IP ACL.

{
  "api_id": "4e1f954c-baf3-11ec-bafe-0242ac110003",
  "message": "IP access control list updated successfully.",
  "ipacl_uuid": "f19c4773-4ae6-4b75-92ea-9cf3ea4227d6"
}

Updating ip_addresses replaces the entire list. Include all IP addresses you want whitelisted.

Example

cURL

curl -i --user AUTH_ID:AUTH_TOKEN \
    -H "Content-Type: application/json" \
    -d '{
      "name": "updated-servers",
      "ip_addresses": ["192.168.0.1", "192.168.0.2", "192.168.0.3"]
    }' \
    https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/f19c4773-4ae6-4b75-92ea-9cf3ea4227d6/

Delete an IP Access Control List

Permanently delete an IP ACL.

HTTP Request

DELETE https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/{ipacl_uuid}/

Response

HTTP 204 No Content

Deleting an IP ACL that is attached to an active trunk will break authentication for that trunk.

Example

cURL

curl -X DELETE -i --user AUTH_ID:AUTH_TOKEN \
    https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/IPAccessControlList/f19c4773-4ae6-4b75-92ea-9cf3ea4227d6/

Usage with Trunks

After creating an IP ACL, attach it to an outbound trunk.

Example

cURL

curl -i --user AUTH_ID:AUTH_TOKEN \
    -H "Content-Type: application/json" \
    -d '{
      "name": "outbound-trunk",
      "trunk_direction": "outbound",
      "ipacl_uuid": "f19c4773-4ae6-4b75-92ea-9cf3ea4227d6"
    }' \
    https://api.plivo.com/v1/Account/{auth_id}/Zentrunk/Trunk/

IP ACL vs Credentials

Method	Use Case
IP ACL	When your PBX has static IP addresses. Simpler setup, no password management.
Credentials	When your PBX has dynamic IPs or you need additional security. Uses SIP digest authentication.

You can use either method (or both) for outbound trunk authentication.

Trunks - Create and manage SIP trunks
Credentials - Alternative authentication via username/password

​API Endpoint

​The IP Access Control List Object

​Attributes

​Example Object

​List All IP Access Control Lists

​HTTP Request

​Query Parameters

​Response

​Example

​Retrieve an IP Access Control List

​HTTP Request

​Response

​Example

​Create an IP Access Control List

​HTTP Request

​Request Parameters

​Response

​Error Codes

​Example

​Update an IP Access Control List

​HTTP Request

​Request Parameters

​Response

​Example

​Delete an IP Access Control List

​HTTP Request

​Response

​Example

​Usage with Trunks

​Example

​IP ACL vs Credentials

​Related

API Endpoint

The IP Access Control List Object

Attributes

Example Object

List All IP Access Control Lists

HTTP Request

Query Parameters

Response

Example

Retrieve an IP Access Control List

HTTP Request

Response

Example

Create an IP Access Control List

HTTP Request

Request Parameters

Response

Error Codes

Example

Update an IP Access Control List

HTTP Request

Request Parameters

Response

Example

Delete an IP Access Control List

HTTP Request

Response

Example

Usage with Trunks

Example

IP ACL vs Credentials

Related