Retriever API Keys

Revoke Retriever API Key

Changed on

Revoke a retriever-scoped API key.

**Effect:**
- Key status is set to REVOKED
- Key can no longer be used for authentication
- Revocation is immediate (no grace period)
- Auth cache is invalidated immediately
- Cannot be undone (create a new key if needed)

**Audit:**
- Revocation is logged in the retriever's audit trail
- Includes actor user ID and timestamp
delete/v1/retrievers/{retriever_id}/api-keys/{key_id}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/retrievers/{retriever_id}/api-keys/{key_id}
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

retriever_idstring required
key_idstring required

Response

Successful Response

messagestring
successboolean

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API