Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Credentials

Delete Credential

Permanently remove SIP credentials from a trunk.

This API permanently deletes a credential from a trunk. Once deleted, the credential can no longer be used for SIP authentication, and any devices or applications using this credential will be unable to connect. This action cannot be undone.

Warning: Deleting a credential will:

  • • Immediately prevent authentication using this username and password
  • • Disconnect any active calls using this credential
  • • Block any devices configured with this credential from making new calls
  • • Permanently remove the credential - this cannot be undone

Alternative: Consider disabling the credential instead (set enabled: false) to temporarily prevent authentication while preserving the credential for future use or audit purposes.

HTTP Request

DELETEhttps://api.vobiz.ai/api/v1/account/{account_id}/credentials/{credential_id}

Authentication: Bearer token required. Include X-Auth-ID header.

Response

Returns HTTP 204 No Content on successful deletion. No response body is returned.

Response - 204 No Content
No Content

Error Responses:

  • • 404 Not Found: Credential does not exist or doesn't belong to the specified trunk
  • • 409 Conflict: Credential is currently in use by active calls (wait for calls to end first)

Examples

cURL

cURL Request
curl -X DELETE https://api.vobiz.ai/api/v1/account/{Auth_ID}/credentials/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Before Deleting:

  • • Verify no active calls are using this credential
  • • Document the credential details (username, description) for records
  • • Check if any devices or applications are configured with this credential
  • • Notify affected users who may be using this credential
  • • Consider disabling instead of deleting to preserve audit trail
  • • Ensure you have alternative credentials configured for the trunk

Common Use Cases:

  • • Removing credentials for decommissioned devices
  • • Cleaning up test credentials after development
  • • Deleting compromised credentials after creating replacements
  • • Removing access for users who no longer need it

Recovery: If you accidentally delete a credential, you cannot recover it. You'll need to create a new credential with a new username and password, then reconfigure all affected devices.

Update Credential
IP ACL Overview