CreateApiKey

object

Fields

namestringrequired
1–80 characters
scopesarray of enumrequired
1–40 items
One ofcatalog:readcollection:readcollection:writewishlist:readwishlist:writescans:write
and 37 more
scans:readlabels:readlabels:writeinsights:readinsights:writeexports:readholds:readholds:writequestions:readquestions:writeaccount:readaccount:writeaccount:deletereports:writestores:readstores:writeassistant:usestore:readstore:inventory:readstore:inventory:writestore:holds:readstore:holds:writestore:questions:readstore:questions:writestore:storefront:writestore:staff:readstore:staff:writestore:billing:readadmin:catalog:readadmin:catalog:writeadmin:moderation:writeadmin:imports:writeadmin:users:readadmin:users:writeadmin:support:writeadmin:ops:readadmin:ops:write
expiresInDays"7" or "30" or "90" or "180" or "365" or null
Days until it stops working, or null for never. Admin keys must expire within 90 days.
default null
ShowHide the fields of expiresInDays
1. Option 1: "7"
2. Option 2: "30"
3. Option 3: "90"
4. Option 4: "180"
5. Option 5: "365"
ipAllowlistarray of string or null
Admin keys only: the addresses or CIDR ranges it may be used from.
at most 20 items

CreateApiKey · example shape

{
  "name": "string",
  "scopes": [
    "catalog:read"
  ],
  "expiresInDays": 7,
  "ipAllowlist": [
    "string"
  ]
}

From the schema: placeholder values, not real data.