Keys

Revoke an API key

Soft-revoke one of this account's API keys. Idempotent per key; a revoked key can never authenticate again. Requires the keys:manage scope. Returns 404 for an unknown id, an already-revoked key, or another account's key.

delete/api/v1/keys/{id}

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/keys/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

The id of the key to revoke (from POST/GET /api/v1/keys).

Example:42

Response

The key was revoked.

idinteger required
revokedtrue required

Always true on success.

Changes

No recorded changes to this operation across all 1 revision of this API.