POST

/api/im/remote/pair/apikey-bind

Direct API key binding

Daemon registers itself using an API key (Entry A — no QR scan required). Creates an

active DesktopBinding immediately. Preferred for headless daemons and CI runners.

当前语言暂无代码示例

请求体

FieldTypeReqDefaultDescription
daemonIdstringY
daemonPubKeystringY
daemonSignPubstringY
deviceNamestringN
relayRegionstringNPreferred relay region hint (e.g. "us-west-2")
candidatesany[]Nv1.9.0 — Daemon-advertised LAN + relay connection candidates. Validated against the Offer v2 candidate schema (1-8 entries); malformed input returns 400 `BINDING_CANDIDATES_INVALID`.
typestring (directTcp | relay)YChannel kind.
hoststringNRequired when `type=directTcp`. Hostname or IP (1–253 chars).
portintegerNRequired when `type=directTcp`. TCP port.
endpointstringNRequired when `type=relay`. WSS relay URL (e.g. `wss://relay-us-west.prismer.cloud`).
priorityintegerNOptional client hint (lower = preferred).
metadataobjectNOptional free-form metadata attached by the daemon.

响应示例

{
  "ok": true,
  "data": {
    "bindingId": "binding-uuid"
  }
}

Try it out

Sign in to use your API key
Request Body
Response
Click Execute to test