Credentials
Delete Credential
Permanently revoke a SIP digest credential from your Vobiz trunk - every device or AI agent using that username loses authentication access immediately.
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>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}
Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth TokenContent-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
enabled: false) to temporarily prevent authentication while preserving it for future use or audit purposes.Response
Returns204 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.
Was this page helpful?
⌘I
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>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"