This API creates a new IP ACL entry to whitelist an IPv4 address for authentication on the account. Once added, calls originating from the whitelisted IP address will be allowed without requiring credential authentication (unless both authentication methods are required).
Public IP Required: Make sure to whitelist your public IP address, not a private/internal IP. If you're behind NAT, use your router's public IP address.
IPv4 Only: Only IPv4 addresses are supported. IPv6 addresses will be rejected with a validation error.
HTTP Request
https://api.vobiz.ai/api/v1/account/{account_id}/ip-aclAuthentication Required:
- • X-Auth-ID: Your account ID (e.g., {Auth_ID})
- • X-Auth-Token: Your account Auth Token
- • Content-Type: application/json
Request Parameters
Request Parameters
| Name | Type | Description |
|---|---|---|
ip_addressRequired | string | IPv4 address in dotted-decimal notation (e.g., 203.0.113.50 or 192.168.1.100). Must be a valid IPv4 format. |
enabled | boolean | Whether the IP ACL entry is active and can be used for authentication. Default: true. Set to false to create a disabled entry. |
description | string | Optional description providing context about the IP address, such as "Office static IP", "PBX server", or "Carrier connection". |
Response
Returns the complete IP ACL object including the auto-generated id UUID and timestamps.
{
"id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
"ip_address": "192.168.1.100",
"description": "Office IP address",
"enabled": true,
"created_at": "2025-01-22T11:20:30Z",
"updated_at": "2025-01-22T11:20:30Z"
}Examples
cURL - Basic IP ACL
curl -X POST https://api.vobiz.ai/api/v1/account/{Auth_ID}/ip-acl \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ip_address": "203.0.113.50",
"description": "Office static IP",
"enabled": true
}'cURL - PBX Server IP
curl -X POST https://api.vobiz.ai/api/v1/account/{Auth_ID}/ip-acl \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ip_address": "198.51.100.42",
"description": "FreePBX server in data center",
"enabled": true
}'Error Response (400 Bad Request): If the IP address format is invalid:
{
"error": "Invalid IP address format",
"code": 400
}Next Steps:
- • Save the IP ACL
idfor future operations - • Verify the IP address is correct before testing
- • Test connectivity by making a call from the whitelisted IP
- • Monitor authentication logs to confirm IP-based auth is working
NAT Tip: If you're behind NAT or a firewall, determine your public IP with:curl https://api.ipify.org