Revoke key

Revoke a credential immediately.

DELETE/keys/{key_id}

PermissionCluster key, or a namespace key managing collection keys within its namespace. Key scopes and actions.

Successful revocation returns 204 with no body. Future requests with the revoked secret fail authentication.

Request

https://engine.example.com/keys/key_01K6Q6N7D8E9F0G1H2J3K4M5N6

DELETE /keys/key_01K6Q6N7D8E9F0G1H2J3K4M5N6 HTTP/1.1
Host: engine.example.com
Authorization: Bearer <GRAPHON_ENGINE_API_KEY>

Replace engine.example.com with your cluster host. Examples use a key placeholder.

204

Revocation completed. This response has no body.

This response has no body.

key_idstringrequired

Administrative key ID with the key_ prefix. Use the ID returned by create or list, not the secret.

Revocation completed. This response has no body.

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

This response has no body.

Select an error in the response example to see its JSON body. See error handling for the common error format.

A field, path, parameter, or conditional request rule is invalid.

What to do: Correct the request. Unknown fields are rejected.

The API key is missing, invalid, or revoked.

What to do: Send an active key in Authorization: Bearer or X-API-Key.

The key can see the resource but lacks permission for this operation.

What to do: Use a key with the required action or scope kind.

The resource is absent, deleted, or outside this key’s scope.

What to do: Check the identifier and the key’s namespace and collection scope.

A dependency, cluster readiness condition, or capacity limit prevents this operation.

What to do: Inspect retryable and details. Retry only when permitted, preserving the idempotency key for the same write.

An unexpected server failure prevented this request from completing.

What to do: Retain request_id for investigation. Follow retryable before retrying a write.

Was this page helpful?