Sign in
v1
api-keys

Revoke API key

Revoke an API key

delete/api/api-keys/{key_id}

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

Changes

Changed in 2 of the 92 revisions of this API.33

  • 183f82172fec3See the full diff
    • ○

      added the optional property organization_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property owner_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property team_id_restriction to the response with the 200 status

      response-optional-property-added

  • 8c84efcb3afb3See the full diff
    • ●

      removed the optional property organization_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property owner_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property team_id_restriction from the response with the 200 status

      response-optional-property-removed

    This revision also has 96 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog