This section provides the steps for removing an existing personalized API key. Only the Administrators role in BlueDolphin enables the user to delete personalized API keys of other users.
HTTP responses
|
HTTP response status code |
Interpretation |
|---|---|
|
200 OK |
API key deleted successfully |
|
401 Unauthorized |
Invalid or missing API key secret and/or tenant |
|
400 Bad Request |
One or more validation errors occurred. ID is either missing, incorrect, or does not exist in the database. |
To delete an existing personalized API key, make a DELETE request to the /user-api-keys/{id} endpoint specifying:
-
Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the user API key that you want to have removed from the system.
-
The header for your API request
To delete the API key with the id 63c57b3882345012d9e7a157, we will pass a DELETE request to the URI https://public-api.eu.bluedolphin.app/v1/user-api-keys/63c57b3882345012d9e7a157.
curl -L -X DELETE 'https://public-api.eu.bluedolphin.app/v1/user-api-keys/63c57b3882345012d9e7a157' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json'
A typical successful call returns a response with a 200 OK HTTP status code and the following body. However, the text in the response body might vary in case there are certain exceptions.
{
"result": "OK"
}
Comments
0 comments
Please sign in to leave a comment.