Skip to main content
DELETE
/
api
/
v1
/
account
/
{auth_id}
/
credentials
/
{credential_id}
Delete a credential
curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/account/{auth_id}/credentials/{credential_id} \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
"<string>"

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.

DELETE https://api.vobiz.ai/api/v1/account/{auth_id}/credentials/{credential_id}
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 it will be unable to connect. This action cannot be undone.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
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 it for future use or audit purposes.

​
Response

Returns 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 does not 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: Deleted credentials cannot be recovered. You must create a new credential with a new username and password, then reconfigure all affected devices.

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"

​
credential_id
string
required

Response

Success

The response is of type string.