Skip to main content
POST
/
api
/
v1
/
auth
/
device-code
Initiate the device-code flow
curl --request POST \
  --url https://breadbox.example.com/api/v1/auth/device-code
{
  "device_code": "<string>",
  "user_code": "<string>",
  "verification_url": "<string>",
  "expires_in": 123,
  "interval": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Response

201 - application/json

Pending device-code created.

device_code
string
required

Opaque polling credential carried by the CLI

user_code
string
required

8-char human-facing code formatted XXXX-XXXX

verification_url
string
required

URL the operator opens to approve

expires_in
integer
required

TTL in seconds (10 minutes by default)

interval
integer
required

Suggested polling cadence in seconds