PHphilterd
API Keys

Revoke an API key.

Changed on

Revokes a key: it stops authenticating at once and cannot be restored. The key making the request cannot revoke itself; revoke it with another key. The calling key cannot revoke a key holding a scope it does not hold. A caller can revoke its own user's keys; an administrator can revoke any user's. Recorded as an api_key_deleted audit event naming the calling user and API key. Requires the api-keys:write scope.

delete/api/api-keys/{keyId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/api-keys/{keyId}
  • Auth
    HTTP bearer

Path parameters

keyIdstring required

Headers

Authorizationstring required

Response

The key was revoked.

Changes

  • c4f85daa9208Revision 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

    • 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

    • 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

    • 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

  • 4082c17721d8Revision changes
    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status