Skip to content

Revoke an API key (idempotent)

DELETE
/v1/keys/{id}
id
required
string
/^apk_[a-z0-9]{21}$/

Key revoked (or already was).

Missing or invalid API key.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable

Key not found or not owned by the authenticated user.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable

Rate limit exceeded.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable