The IP ACL Object
Complete structure and attributes of an IP Access Control List object.
The IP ACL object represents a whitelisted IPv4 address that can authenticate to a specific trunk without requiring credentials. Each IP ACL entry is associated with a trunk and contains the IP address along with optional metadata like description and enabled status.
IPv4 Only: The ip_address field only accepts IPv4 addresses in standard dotted-decimal notation (e.g., 192.168.1.1). IPv6 addresses are not currently supported.
Public IPs: Ensure you whitelist the public IP address, not private/internal IPs. For devices behind NAT, use the router's public IP address.
Attributes
IP ACL Attributes
| Name | Type | Description |
|---|---|---|
id | string (UUID) | Unique identifier for the IP ACL entry. Automatically generated upon creation. |
trunk_id | string (UUID) | The ID of the trunk this IP ACL entry belongs to. |
ip_address | string | IPv4 address in dotted-decimal notation (e.g., 203.0.113.50). Required field. Must be a valid IPv4 address. |
description | string | Optional description providing context about the IP address, such as "Office static IP" or "PBX server". |
enabled | boolean | Whether the IP ACL entry is active and can be used for authentication. Default: true. |
created_at | string (ISO 8601) | Timestamp when the IP ACL entry was created. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
updated_at | string (ISO 8601) | Timestamp of the last update to the IP ACL entry. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
Example
IP ACL Object Response
A typical IP ACL object as returned by the API:
{
"id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
"trunk_id": "bfab10fb-cb97-488b-9c63-989c32980b0f",
"ip_address": "203.0.113.50",
"description": "Office static IP",
"enabled": true,
"created_at": "2025-01-15T10:40:15Z",
"updated_at": "2025-01-15T10:40:15Z"
}Best Practices:
- • Only whitelist IP addresses you control and trust
- • Use descriptive descriptions to identify each IP's purpose
- • Regularly audit your IP ACL list and remove unused entries
- • For dynamic IPs, consider using credential authentication instead
- • Test connectivity after adding new IP addresses
- • Disable rather than delete entries when temporarily blocking access
Finding Your Public IP: If you're unsure of your public IP address, you can check it by running curl https://api.ipify.org from your command line or visiting the URL in your browser.