Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

The IP ACL object represents a whitelisted IPv4 address that can authenticate to a trunk without requiring credentials. Each IP ACL entry is associated with a trunk and contains the IP address along with optional metadata such as 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

FieldTypeDescription
idstring (UUID)Unique identifier for the IP ACL entry. Automatically generated upon creation.
account_idstringAccount this IP ACL entry belongs to.
ip_addressstringIPv4 address or CIDR block in dotted-decimal notation (e.g., 192.168.1.0/24). Required. Must be a valid IPv4 address or CIDR range.
descriptionstringOptional description with context about the IP address, such as “Office static IP” or “PBX server”.
enabledbooleanWhether the IP ACL entry is active and can be used for authentication. Default: true.
created_atstring (ISO 8601)Timestamp when the IP ACL entry was created. Format: YYYY-MM-DDTHH:mm:ssZ (UTC).
updated_atstring (ISO 8601)Timestamp of the last update to the IP ACL entry. Format: YYYY-MM-DDTHH:mm:ssZ (UTC).

​
Example

​
IP ACL Object Response

A typical IP ACL object returned by the API:
IP ACL Object
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "",
  "ip_address": "192.168.1.0/24",
  "description": "Office IP",
  "enabled": true,
  "created_at": "2026-03-18T14:41:41Z",
  "updated_at": "2026-03-18T14:41:41Z"
}
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: To check your public IP address, run curl https://api.ipify.org from your command line or visit the URL in your browser.