MImixedbread
api_keys

Revoke API key

Changed on

Revoke a specific API key by its ID.

Args: api_key_id: The ID of the API key to revoke.

Returns: ApiKey: The response containing the details of the revoked API key.

post/v1/api-keys/{api_key_id}/revoke

Request

  • Base URL
    https://api.mixedbread.com
  • URL
    https://api.mixedbread.com/v1/api-keys/{api_key_id}/revoke
  • Auth
    HTTP bearer

Path parameters

api_key_idstring uuid required

The ID of the API key to revoke

Response

The revoked API key details

idstring required

The ID of the API key

namestring required

The name of the API key

redacted_valuestring required

The redacted value of the API key

expires_atstring date-time nullable

The expiration datetime of the API key

created_atstring date-time required

The creation datetime of the API key

updated_atstring date-time required

The last update datetime of the API key

last_active_atstring date-time nullable

The last active datetime of the API key

object'api_key'

The type of the object

Changes

  • 3b2f85375e9cRevision changes
    • info

      added the optional property /// to the response with the status

  • 88bcf0a5d27eRevision changes
    • breaking

      the response property const value store was removed for the status

    • warning

      added the new completions enum value to the //// response property for the response status

    • warning

      added the new store enum value to the //// response property for the response status