Skip to content

Machine server access

bb 0.43.3SDK 0.4.104pinned e865697 (desktop-v0.43.3)

experimental Plugin backend Show on the zone map

Registers server access for enrolment and ongoing machine runtime requests. With this, a plugin can:

Connect machines to their server

What it gives you

  • Register bb.experimental_serverAccess with picker copy, availability (including an optional public serverUrl), idempotent acquire and release
  • Call recheck when access is gained or lost; refreshed configuration checks availability for Machines settings, manual setup and creation banners
  • Return { id, serverUrl, headers? }; machines attach headers to all server requests without provider-specific redemption
  • Choose a General default; core retains the selection for each machine; automatic selection uses the first registered provider, or direct when none are registered
  • Use the Server URL reachable by machines setting or BB_EXTERNAL_URL fallback; the URL is not a reachability guarantee
  • Return { status: 'failed', message } for a user-safe recovery message; persist acquisition intent and keep credentials in secret storage; release receives key, hostId and a nullable grantId to reconcile interrupted acquisitions before enrollment

API

Each symbol links to the pinned commit it was read at.

Used by

Connect

The brief is Markdown, written for a coding agent: what the capability is, where it registers, every SDK symbol with a pinned permalink, the rules that bite, and what done means.