Skip to main content
POST
Start browser pairing for a machine

Body

application/json
installId
string
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
name
string
required
Required string length: 1 - 128
daemonVersion
string
required
Required string length: 1 - 128
protocol
number
required
rowSchemaVersion
integer
required
Required range: 0 <= x <= 9007199254740991

Response

Pairing started; poll POST /hosts/pairings/poll no faster than interval seconds until expiresAt.

deviceCode
string
required

Secret polling code. Never display or log it.

Pattern: ^[A-Za-z0-9_-]{32,128}$
userCode
string
required

Code the user confirms in the browser.

Pattern: ^[BCDFGHJKLMNPQRSTVWXZ]{4}-[BCDFGHJKLMNPQRSTVWXZ]{4}$
verificationUri
string
required
Required string length: 1 - 2048
verificationUriComplete
string
required
Required string length: 1 - 2048
interval
integer
required

Minimum seconds between polls.

Required range: 1 <= x <= 60
expiresAt
integer
required

Expiry as Unix epoch milliseconds.

Required range: 0 <= x <= 9007199254740991