DELETE/v1/definitions/{key}/api-keys/{keyId}

Remove definitions key api-keys keyId

Revokes one of a page's API keys: the row stays and is stamped revoked, so the record of what was issued survives and the key stops authenticating. Revoking an already-revoked key succeeds without filing a second activity entry. A key belonging to another page answers 'no such key on this page'. Workspace admin.

Access class: def:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

keyIdpath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

:keyIdstringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired