Skip to main content
POST
/
api
/
dashboard
/
sync-keys
Create Sync Key
curl --request POST \
  --url https://api.example.com/api/dashboard/sync-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key_id": "<string>",
  "secret_prefix": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null
​
X-API-Key
string | null
​
X-Stella-Merchant-Id
string | null

Body

application/json
​
description
string | null

Human label for this key, e.g. 'Zunkiree prod'.

Maximum string length: 255

Response

Successful Response

Response from POST /sync-keys. The secret field is shown ONCE and never recoverable from the server afterwards. Frontends/CLIs must surface this clearly to the merchant.

​
id
string<uuid>
required
​
key_id
string
required
​
secret_prefix
string
required
​
description
string | null
required
​
created_at
string<date-time>
required
​
last_used_at
string<date-time> | null
required
​
revoked_at
string<date-time> | null
required
​
secret
string
required

The plaintext sync secret (ssk_sec_<...>). Returned only at creation time; cannot be retrieved later.