Skip to main content
POST
/
desktop
/
pair
/
start
Start a desktop pairing
curl --request POST \
  --url https://core.cyberun.cloud/api/v1/desktop/pair/start
{
  "device_code": "<string>",
  "user_code": "AB7K-PNQ3",
  "verification_uri": "https://app.cyberun.cloud/desktop/pair?user_code=AB7K-PNQ3",
  "expires_in": 300,
  "interval": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.cyberun.cloud/llms.txt

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

Response

200 - application/json

Pairing initialised

Response to POST /desktop/pair/start. Contains everything the desktop needs to open the browser and start polling for confirm.

​
device_code
string
required

Long opaque identifier the desktop uses for polling. Never shown to the user. Treat as a secret — anyone who has it can poll for the issued credential.

​
user_code
string
required

Short human-readable code (8 chars, formatted XXXX-XXXX). The user types or sees this in the browser to confirm they are the one pairing.

Example:

"AB7K-PNQ3"

​
verification_uri
string<uri>
required

Where the user should go in the browser to confirm. The user code is already embedded so the page can pre-fill the confirm form.

Example:

"https://app.cyberun.cloud/desktop/pair?user_code=AB7K-PNQ3"

​
expires_in
integer
required

Seconds until both codes expire and pairing must restart.

Example:

300

​
interval
integer
required

Recommended seconds between Poll calls.

Example:

2