Update IP ACL

Modify an existing IP ACL entry's properties.

This API updates an existing IP ACL entry. You can change the whitelisted IP address, modify the description, or enable/disable the entry. All fields are optional - only include the fields you want to update.

Partial Updates: You can update any combination of fields. Fields not included in the request will retain their current values.

Disable vs Delete: To temporarily block an IP without losing the configuration, setenabled: false instead of deleting the entry.

HTTP Request

PUThttps://api.vobiz.ai/api/v1/account/{account_id}/ip-acl/{ip_acl_id}

Authentication Required:

  • X-Auth-ID: Your account ID (e.g., {Auth_ID})
  • X-Auth-Token: Your account Auth Token
  • Content-Type: application/json

Request Parameters

All parameters are optional. Only include the fields you want to update.

Request Parameters

NameTypeDescription
ip_address
stringNew IPv4 address in dotted-decimal notation. Must be a valid IPv4 format if provided.
enabled
booleanWhether the IP ACL entry is active. Set to false to disable without deleting.
description
stringUpdated description for the IP ACL entry.

Response

Returns the complete updated IP ACL object with the new values and an updatedupdated_at timestamp.

Response - 200 OK
{
  "id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",

  "ip_address": "192.168.1.200",
  "description": "Updated office IP address",
  "enabled": false,
  "created_at": "2025-01-15T10:40:15Z",
  "updated_at": "2025-01-22T11:45:20Z"
}

Examples

cURL - Update IP Address

cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/account/{Auth_ID}/ip-acl/c1d2e3f4-a5b6-7890-cdef-1234567890ab \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ip_address": "192.168.1.200",
    "description": "Updated office IP after ISP change"
  }'

cURL - Disable IP ACL Entry

cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/account/{Auth_ID}/ip-acl/c1d2e3f4-a5b6-7890-cdef-1234567890ab \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'

cURL - Update Description Only

cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/account/{Auth_ID}/ip-acl/c1d2e3f4-a5b6-7890-cdef-1234567890ab \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Main office - Building A"
  }'

IP Address Changes: If you update the IP address, existing authenticated connections may be disconnected. Plan IP changes during maintenance windows.

Error Response (400 Bad Request): If the new IP address format is invalid:

Error Response - 400 Bad Request
{
  "error": "Invalid IP address format",
  "code": 400
}

Best Practice: When changing IP addresses, add the new IP first, test connectivity, then disable or delete the old IP entry to avoid service interruption.