API Keys

Update API key

Changed on

Renames an active API key or changes its scope. Send name, scope or both.

patch/api-keys/{id}

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/api-keys/{id}
  • Auth: API key in cookie __Host-xquik_session

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Request body

namestring

Up to 100 characters. An empty name saves the key as Default.

scope'full' | 'paid_reads'

The scope to save. The key's next request uses it.

Example request

{
  "name": "Analytics notebook",
  "scope": "paid_reads"
}

Response

API key updated

idstring required
namestring required
prefixstring required
scope'full' | 'paid_reads' required

full calls every route an API key can use. paid_reads calls paid X read routes only, & other routes answer it with 403.

isActiveboolean required
createdAtstring date-time required
expiresAtstring date-time

When the key stops working. Missing when it never expires.

lastUsedAtstring date-time

When the key last made a request. Missing until it does.

Example response

{
  "id": "42",
  "name": "My API Key",
  "prefix": "xq_live_exam",
  "scope": "paid_reads",
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "expiresAt": "2025-02-14T12:00:00Z",
  "lastUsedAt": "2025-01-16T09:30:00Z"
}

Changes