staqlydocs
REST APIAPI referenceAuth

Create a one-time "connect a device" link

Create a one-time "connect a device" link (QR code)

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/device-links

Dashboard only (session or local principal). The token is in the URL fragment, valid for 5 minutes, single use.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Response Body

Created

application/json
  1. response
url*string
expires_at*string
Formatdate-time
reachable*boolean

false when the URL points at localhost

hint?string
curl -X POST 'https://staqly.example.com/v1/device-links'
{  "url": "https://staqly.example.com/connect#abc...",  "expires_at": "2019-08-24T14:15:22Z",  "reachable": true,  "hint": "string"}