DELETE/api/v1/keys/{hash}

Revoke an API key

Needs a provisioning key (403 otherwise). Idempotent; a repeated delete of a revoked key still succeeds.

Authentication: Bearer API key in the Authorization header

Path parameters

  • hashstringrequired

    The key id (hash in key objects).

Responses

  • 200

    The key is revoked.

    Response
    • dataobjectrequired
      data
      • successbooleanrequired
  • 401

    Missing, unknown or revoked API key.

    Response
    • errorstringrequired

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 403

    The key is valid but may not perform this action (for example an inference key on a provisioning-key route, or a feature outside your plan).

    Response
    • errorstringrequired

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 404

    No key with this id in your organization.

    Response
    • errorstringrequired

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

Request

curl -X DELETE https://api.experientiallabs.ai/api/v1/keys/0b9d4f6e-2a1c-4e8b-9f37-5c6d2e1a8b40 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": {
    "success": true
  }
}

https://api.experientiallabs.ai/api/v1/keys/0b9d4f6e-2a1c-4e8b-9f37-5c6d2e1a8b40