API Keys

Pause or resume API keys

Changed on

Pauses or resumes up to 100 of your API keys at once & lists the keys it changed, newest first. It skips revoked, expired, unknown & other accounts' keys. Pausing again keeps the first pause time.

patch/api/v1/api-keys

Request

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

Request body

idsstring[] required
pausedboolean required

true pauses every listed key, so their calls get 403 api_key_paused. false resumes them at once.

Example request

{
  "ids": [
    "42",
    "43"
  ],
  "paused": true
}

Response

API keys paused or resumed

Example response

{
  "keys": [
    {
      "id": "43",
      "name": "Analytics notebook",
      "prefix": "xq_live_exam",
      "scope": "paid_reads",
      "scopes": [
        "read"
      ],
      "allowedIps": [],
      "isActive": true,
      "createdAt": "2025-01-15T12:00:00Z",
      "monthlySpentCredits": 0,
      "pausedAt": "2025-01-20T08:00:00Z"
    }
  ]
}

Changes