NewApiKey

A key just made: the only time its secret is shown.

object

Fields

keyApiKeyrequired
tokenstringrequired
The whole key. Store it now: it can’t be shown again.

Used by

POSTMake an admin API key
POSTMake a personal API key
POSTMake a store API key

NewApiKey · example shape

{
  "key": {
    "id": "00000000-0000-4000-8000-000000000000",
    "kind": "personal",
    "name": "string",
    "prefix": "string",
    "display": "string",
    "scopes": [
      "string"
    ],
    "storeId": "00000000-0000-4000-8000-000000000000",
    "owner": {
      "id": "00000000-0000-4000-8000-000000000000",
      "label": "string"
    },
    "status": "active",
    "createdAt": "2026-10-11T12:00:00Z",
    "expiresAt": "2026-10-11T12:00:00Z",
    "lastUsedAt": "2026-10-11T12:00:00Z",
    "lastUsedIp": "string",
    "revokedAt": "2026-10-11T12:00:00Z",
    "revokedReason": "string",
    "ipAllowlist": [
      "string"
    ],
    "rotatedFrom": "00000000-0000-4000-8000-000000000000",
    "usage": null
  },
  "token": "string"
}

From the schema: placeholder values, not real data.