Skip to Content
ReferenceAPI referenceAuth

List API keys

GET
/api/v1/auth/api-keys

Returns every key, newest first, with its scope, expiry, and when and from which IP it was last used. The key itself never appears after creation. API keys get a 403 here; use a browser session.

Authorization

sessionCookie
cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

Every stored API key, newest first.

available*boolean

False on a server with APP_AUTH_DISABLED=true, where keys cannot exist.

keys*array<>
Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/auth/api-keys'
Example Response
{  "available": true,  "keys": [    {      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "displayPrefix": "string",      "expired": true,      "expiresAt": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "lastUsedAt": "2019-08-24T14:15:22Z",      "lastUsedIp": "string",      "name": "string",      "scope": "read"    }  ]}

Get the log ingestion counters GET

Returns the line and record counters of this process, and the state of each Loki query in LOKI_QUERIES. The counters start at zero when the process starts. Without an ingestion service, as with LOGPARSER_ENABLED=false, every counter is 0, `isRunning` is false and `lokiSources` is 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.