staqlydocs
REST APIAPI referenceAuth

Sign in to the dashboard with an admin API key

Sign in to the dashboard with an admin API key (or, in the Community Edition, the access token)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/sessions/api-key

Community Edition: exchanges the access token (stk_local_...) for a browser session cookie; a wrong token gets 401. Cloud mode: exchanges an API key with the admin scope (the key sign-up or recovery returns) for a browser session cookie. Keys without admin (agent keys) get 403; unknown, revoked or expired keys get 401. The key goes in the body, not in Authorization. Other sessions stay signed in. Recorded as a session.signed_in event. Rate-limited per client IP (429).

Request Body

application/json
  1. body
api_key*string

An admin key, stk_...

Response Body

Session cookie set

application/json
  1. response
csrf_token*string
curl -X POST 'https://staqly.example.com/v1/sessions/api-key' \  -H 'Content-Type: application/json' \  -d '{  "api_key": "string"}'
{  "csrf_token": "string"}