PilotFoxDocs

Delete an API key

DELETE
/api/v1/orgs/{orgId}/api-keys/{keyId}

Deletes the key: it is refused from then on, though a verification already cached can let it through for up to 60 seconds. 404 when the organization has no such key.

Requires apiKey:delete in the organization (an API key, or a signed-in member's role; a member restricted to some sites holds a viewer's permissions here). API keys limited to some sites: 403. Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: apiKey:delete

Path Parameters

orgId*string
keyId*string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X DELETE 'https://pilotfox.app/api/v1/orgs/string/api-keys/string'
Example Response200
{  "data": {    "deleted": true  }}