Skip to main content
POST
Revoke a tool credential

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.

Headers

Idempotency-Key
string
required

A unique key (a UUID works) for this request. Retrying with the same key returns the first answer instead of running twice.

Maximum string length: 255
Kallabot-Version
enum<string>

The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.

Available options:
2026-11-07
Example:

"2026-11-07"

Path Parameters

credential_id
string
required

Response

Successful Response

A saved secret tools sign in with. The secret itself is never returned.

id
string
required

The credential's id. Reference it from a tool as auth.credential_id.

label
string
required

Its name.

auth_type
enum<string>
required

How it signs in. oauth2 and mcp_oauth come from a sign-in flow, not this API.

Available options:
bearer,
header,
basic,
query,
oauth2,
mcp_oauth
status
enum<string>
required

Whether tools can use it.

Available options:
active,
needs_reauth,
revoked,
error
header_name
string | null

The header it is sent in (header only).

query_name
string | null

The query parameter it is sent in (query only).

hint
string
default:""

The secret's last few characters, to tell keys apart.

oauth_provider
string | null

The OAuth provider (OAuth credentials only).

issuer
string | null

The OAuth issuer (OAuth credentials only).

scopes
string[]

Granted OAuth scopes.

expires_at
string | null

When the access token expires (ISO 8601).

last_error
string | null

The last error code, if any.

last_used_at
string | null

When a tool last used it (ISO 8601).

rotated_at
string | null

When the secret was last replaced (ISO 8601).

revoked_at
string | null

When it was revoked (ISO 8601).

created_at
string | null

When it was created (ISO 8601).

updated_at
string | null

When it last changed (ISO 8601).