Account

Revoke API key

Changed on

Permanently revokes a company-scoped API key. The caller must have the api_keys:manage permission. The response contains non-secret metadata only.

delete/api-keys/{apiKeyId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/api-keys/{apiKeyId}
  • Auth
    HTTP bearer

Path parameters

apiKeyIdstring required

Exact API key ID returned by the list API keys endpoint.

Response

API key revoked

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "API key revoked successfully."
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status