v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01302395850.8 KB
v1
api-keys

Suspend API key

Suspend an API key

post/api/api-keys/{key_id}/suspend

Path parameters

key_idstring required

Response

Successful Response

user_idstring required
scopesAPIKeyPermission[] required
type'api_key'
created_atstring date-time required
expires_atstring date-time nullable
last_used_atstring date-time nullable
revoked_atstring date-time nullable
organization_idstring nullable
team_id_restrictionstring nullable
idstring required
namestring required
headstring required

The first 8 characters of the key

tailstring required

The last 8 characters of the key

status'ACTIVE' | 'REVOKED' | 'SUSPENDED' required
descriptionstring nullable
owner_typestring nullable