API keys
Revoke API key
How to revoke and delete an API key.
DELETE
/
api-keys
/
{id}
curl -X DELETE "http://localhost:5001/api-keys/<api-key-id>?owner=owner_id" \
-H "X-blnk-key: <api-key>"
{}
{
"error": "API key not found",
"error_detail": {
"code": "APIKEY_NOT_FOUND",
"message": "API key not found"
}
}
Use this endpoint to revoke unused or expired API keys to maintain good security hygiene.
Revoking an API key immediately revokes access, so ensure you update your applications with a new API key before revoking the old one.
Available on version 0.10.1 or later. Requires the master key or an API key with
api-keys:delete scope.If you’re using the auto-provisioned
Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.Authorization
If set, the API uses an API key for authentication. Include the following header in your requests:X-blnk-key: <api-key>.
Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.
See also: Scoped API keys and Secure your Blnk server.
Path Parameters
string
required
The unique identifier of the API key to revoke.
Query Parameters
string
Unique identifier of the owner whose key you want to revoke.
Response
Returns 204 No Content upon successful revocation.curl -X DELETE "http://localhost:5001/api-keys/<api-key-id>?owner=owner_id" \
-H "X-blnk-key: <api-key>"
{}
{
"error": "API key not found",
"error_detail": {
"code": "APIKEY_NOT_FOUND",
"message": "API key not found"
}
}
Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.Was this page helpful?
⌘I
curl -X DELETE "http://localhost:5001/api-keys/<api-key-id>?owner=owner_id" \
-H "X-blnk-key: <api-key>"
{}
{
"error": "API key not found",
"error_detail": {
"code": "APIKEY_NOT_FOUND",
"message": "API key not found"
}
}