Start Quick Start on a new computer

POST

/quickstart/start

curl --request POST \
  --url http://127.0.0.1:7700/api/quickstart/start \
  --header 'Authorization: Bearer <token>'

• On the box itself (the default listen address)
• From another device, with a paired device token, when BOX_LISTEN allows it

Only on the new computer’s own screen (anyone else gets 403), and only during setup (else 409). Makes a one-time key and a rendezvous slot at the relay, valid for 10 minutes. Show url as a QR code and the four-word phrase beside it. The owner’s phone scans the code and asks a computer it owns to send. The relay sees only ciphertext.

Authorizations

• deviceToken
• accessToken

Responses

200

Where to point the phone.

Media typeapplication/json

object

url

required

The QR code’s address. Everything the phone needs is after the #.

string

state

required

string

Allowed values: off waiting applying done stopped error

phrase

Four words to compare on both screens.

string

steps

required

What was applied

Array<string>

error

string

expiresAt

string format: date-time

Example

{
  "state": "off"
}

403

Not the box’s own screen.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}

409

Setup is finished. Quick Start is for a new computer.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}