Skip to content
Subako Docs
Esc
↑↓navigate↵open⌘Jpreview

DELETE /v1/api-keys/{api_key_id}

DELETE/v1/api-keys/{api_key_id}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
api_key_idstring<uuid>required
API key id
Responses
200Revoked. Repeating it returns the same revoked_at.
created_atstring<date-time>required
created_byActorBodyrequired
Who did something, resolved for display. `users` rows are never deleted, so this renders after a membership ends.
Show properties
display_namestring | nullrequired
primary_emailstring | nullrequired
user_idstring<uuid>required
expires_atstring<date-time> | nullrequired
idstring<uuid>required
labelstringrequired
last_used_atstring<date-time> | nullrequired
permissionsKeyPermissionSchema[]required
prefixstringrequired
Non-secret display prefix: the key's marker, its environment, and eight characters of the secret.
revoked_atstring<date-time> | nullrequired
400Malformed path parameter.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
401Missing, malformed, or invalid bearer token.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
404No such api key, or the caller cannot see its workspace.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X DELETE "https://api.us.cloud.subako.ai/v1/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "display_name": "string",
    "primary_email": "string",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
  },
  "expires_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "last_used_at": "2019-08-24T14:15:22Z",
  "permissions": [
    "workspace.read"
  ],
  "prefix": "string",
  "revoked_at": "2019-08-24T14:15:22Z"
}