Skip to content

APIKey API โ€‹

Create API Key โ€‹

prolog
POST API_BASE/apikeys

Authorization Required โ€‹

OAuthAPIKey
NoNo

Request Body โ€‹

json
{
  "name": "My Key"
}

Response โ€‹

json
{
  "data": APIKeyObject,
  "ts": 1723923923
}

List API Keys โ€‹

prolog
GET API_BASE/apikeys

Authorization Required โ€‹

OAuthAPIKey
YesYes

OAuth scope: apikey.read

Response โ€‹

json
{
  "data": [APIKeyObject, ...],
  "ts": 1723923923
}

Delete API Key โ€‹

prolog
DELETE API_BASE/apikeys/:id

Authorization Required โ€‹

OAuthAPIKey
NoNo

Parameters โ€‹

ParameterTypeDescription
iduint64The ID of the API key

Response โ€‹

json
{
  "data": APIKeyObject,
  "ts": 1723923923
}

Verify API Key Hash โ€‹

prolog
POST API_BASE/apikeys/verify

Authorization Required โ€‹

OAuthAPIKey
YesYes

OAuth scope: apikey.read

Request Body โ€‹

json
{
  "hash": "sha256_hex_of_apikey"
}

Response โ€‹

json
{
  "data": {
    "valid": true
  },
  "ts": 1723923923
}