v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB
CLI

Start CLI browser login

Starts a browser-assisted CLI login session. The response includes a device code for polling and a user code that the user approves in the browser. This endpoint does not require an API key.

post/cli/login/start

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

device_namestring

Human-readable device name shown during browser approval

metadataobject

Optional client metadata stored with the login session; serialized JSON must be 2048 bytes or fewer

Response

CLI login session created

successtrue required