/bff/api-key/set-active

Toggles the is_active flag of an API key. A deactivated key rejects new requests but remains stored, so it can be reactivated later. Use this to temporarily pause an integration without discarding the credential. Deleted keys (isDeleted: true) cannot be toggled — generate a new key instead.

API KeypostBffApi-keySet-active

Parameters

JSON body

Request body

application/json

idstringRequired

External identifier (UUID) of the API key.

Example550e8400-e29b-41d4-a716-446655440000

activebooleanRequired

True to reactivate, false to deactivate. Deleted keys cannot be toggled.

Response schema

1 status code documented

200SuccessActive flag updated successfully.

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/api-key/set-active

post

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key