/bff/api-key/invalidate-key

Marks an API key as deleted, making it immediately unusable for API requests. This action is permanent and cannot be undone. The key will still appear in the list but with isDeleted: true. Use this when a key has been compromised or is no longer needed.

API KeypostBffApi-keyInvalidate-key

Parameters

JSON body

Request body

application/json

idstringRequired

External identifier (UUID) of the API key to invalidate.

Example550e8400-e29b-41d4-a716-446655440000

Response schema

1 status code documented

200SuccessKey invalidated successfully.

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/api-key/invalidate-key

post

curl -X POST "https://api.bizkithub.com/bff/api-key/invalidate-key" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key