Skip to Content
ReferenceAPI referenceAuth

Revoke an API key

DELETE
/api/v1/auth/api-keys/{key_id}

Deletes the key, so every request that sends it gets a 401 from then on. API keys get a 403 here; use a browser session.

Authorization

sessionCookie
cookiesession<token>

Session cookie authentication.

Path Parameters

key_id*string

The id of the key, from the key list.

Formatuuid

Response Body

Request fulfilled, nothing follows

Example Request
curl -X DELETE 'https://geometrikks.example.com/api/v1/auth/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Create an API key POST

Creates a key and returns it in `key`. This is the only time the full key appears, so store it now. A taken name gets a 409, and a name outside 1 to 64 characters or an expiry in the past gets a 400. Send the body as `application/json`. API keys get a 403 here; use a browser session.

Check credentials and configured API features GET

Returns the app/API version and configured features without checking external services. API-key requests also return that key's name, scope and expiry. Invalid or expired keys get a coded 401 before this handler runs. Browser sessions return mode=session. With APP_AUTH_DISABLED=true, mode=disabled means a supplied key has not been validated.