Create an API key

POST /v1/api-keys

Generate a new API key. The full key is only returned once on creation.

Requires: apiKey.create

Request Body

API key configuration

CreateApiKeyRequest

expiresAtoptional

string

format: date-time

fullAccessoptional

boolean

ipAllowlistoptional

string[]

namerequired

string

permissionsoptional

enum[]

roleIdsoptional

string[]

Example Request

application/json

{
  "name": "string",
  "fullAccess": true,
  "permissions": [
    "organization.owner"
  ],
  "roleIds": [
    "string"
  ],
  "ipAllowlist": [
    "string"
  ],
  "expiresAt": "2025-01-15T12:00:00.000Z"
}

Response Schema

OneTimeApiKeyInfo

idrequired

string

keyrequired

string

namerequired

string

storeIdrequired

string

Example Response

201 OK — application/json

{
  "id": "string",
  "storeId": "string",
  "name": "string",
  "key": "string"
}