Skip to content

createPairingCode

POST
/auth/pairing-codes
curl --request POST \
--url http://localhost:8080/api/v1/auth/pairing-codes \
--cookie hs_session=<hs_session>

Creates a 10-minute code to sign in the Flutter app by QR (“Open on phone”).

Pairing code created.

Media typeapplication/json
object
code
required

Human-typable fallback.

string
/^[A-Z2-9]{8}$/
qrPayload
required

Homestead://pair?server=&code=

string
expiresAt
required
string format: date-time

Examples

Exampleseed

Derived from fixtures/seed.json.

{
"code": "K3M7QW9Z",
"expiresAt": "2026-10-17T09:10:00.000Z",
"qrPayload": "homestead://pair?server=http://localhost:5173&code=K3M7QW9Z"
}