Skip to content

Revoke Api Key

DELETE
/api/v1/api-keys/{key_id}

Revoke (soft-delete) an API key owned by the authenticated user.

key_id
required
Key Id
string

Successful Response

ApiKeyDeleteResultResponse

Response for DELETE /api/v1/api-keys/{key_id}.

object
success
required
Success
boolean
data
Any of:
ApiKeyDeleteData

Data for the delete response.

object
revoked
required
Revoked
boolean
error
Any of:
ErrorDetail
object
code
required
Code

Machine-readable error code (e.g., ‘NOT_FOUND’, ‘VALIDATION_ERROR’).

string
message
required
Message

Human-readable error message describing what went wrong.

string
details
Any of:

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object