Skip to main content
POST
/
api
/
v1
/
account
/
{auth_id}
/
ip-acl
Create an IP ACL
curl --request POST \
  --url https://api.vobiz.ai/api/v1/account/{auth_id}/ip-acl \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "Office IP"
}
'
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "ip_address": "10.20.30.0/24",
  "description": "",
  "enabled": true,
  "created_at": "2026-03-25T10:00:00Z",
  "updated_at": "2026-03-25T10:00:00Z"
}

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.

POST https://api.vobiz.ai/api/v1/account/{auth_id}/ip-acl
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 are allowed without requiring credential authentication (unless both authentication methods are required).
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Public IP Required: Whitelist your public IP address, not a private/internal IP. If you are 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.

​
Request Parameters

FieldTypeRequiredDescription
ip_addressstringYesIPv4 address in dotted-decimal notation (e.g., 203.0.113.50). Must be a valid IPv4 address.
enabledbooleanNoWhether the IP ACL entry is active. Default: true. Set to false to create a disabled entry.
descriptionstringNoOptional description with 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.
Response - 201 Created
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "",
  "ip_address": "10.20.30.0/24",
  "description": "",
  "enabled": true,
  "created_at": "2026-05-12T05:11:51Z",
  "updated_at": "2026-05-12T05:11:51Z"
}

​
Examples

​
cURL - Basic IP ACL

cURL Request
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 Request
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 Response - 400 Bad Request
{
  "error": "Invalid IP address format",
  "code": 400
}
Next Steps:
  • Save the IP ACL id for 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 are behind NAT or a firewall, determine your public IP with: curl https://api.ipify.org

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Body

application/json
​
name
string
required
​
ip_address
string
required

Response

Success

​
id
string
required
​
account_id
string
required
​
ip_address
string
required
​
description
string
required
​
enabled
boolean
required
​
created_at
string
required
​
updated_at
string
required