Revoke an API credential

Revokes a credential immediately, with no overlap. The credential stops verifying on the next request and refuses with credential_revoked. The row survives its revocation so the credential's history remains answerable, and revoking a credential that is already revoked reports the original revocation rather than moving it. A credential belonging to another project is indistinguishable from one that does not exist. Some calls need more: credentials:administer is required as well when the target was not created by the caller, and the call is refused scope_missing without it.

delete/v1/credentials/{credentialId}

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/credentials/{credentialId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Path parameters

credentialIdstring required

Response

Revoke an API credential

Changes

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