Connect
Start a device-pairing 'Connect' request
Lets any third-party app get an instance's instanceId/API key with one click, instead of a human copying it from the dashboard — works the same whether or not the app has a public callback URL, unlike an OAuth-style redirect (which needs one), so it fits a self-hosted integration just as well as a hosted one. Modeled on RFC 8628's Device Authorization Grant field names, not full OAuth compliance. Open `verificationUri` for the user, then poll POST /connect/token with the returned `deviceCode` in the background until it resolves.
Poll for the outcome of a device-pairing request
Always `200` with a `status` field — poll on a plain interval, never treat any status value as an error. `apiKey`/`instanceId` are only ever present on the single poll call that reveals them (`status: approved`) — save the key immediately, it's never shown again. Every later poll for the same `deviceCode` returns `status: claimed` with no key — `pending` while unresolved, `denied`/`expired` if the user rejected it or it timed out.
Details for the dashboard's Connect approval page
Dashboard-only — a third-party integrator never calls this directly.
Approve a device-pairing request
Dashboard-only. Exactly one of `instanceId` (rotates that instance's API key — this app supports only one active key per instance at a time) or `createInstance` must be given; the latter is subject to the same free-trial 1-instance cap as POST /instances.
Deny a device-pairing request
Dashboard-only.