What another process needs to adopt a VM handed off by sandbox.detach().
Pass the fields to Sandbox.adopt(region, microvmId, endpoint, agentToken, port). The
token is a method rather than a getter so it is never read by accident, and it is absent
from toString(); JSON.stringify of the instance carries nothing.
Accessors
Section titled “Accessors”endpoint
Section titled “endpoint”Get Signature
Section titled “Get Signature”get endpoint(): string;Returns
Section titled “Returns”string
microvmId
Section titled “microvmId”Get Signature
Section titled “Get Signature”get microvmId(): string;Returns
Section titled “Returns”string
Get Signature
Section titled “Get Signature”get port(): number;The daemon port the endpoint’s proxy tokens are minted for.
Returns
Section titled “Returns”number
region
Section titled “region”Get Signature
Section titled “Get Signature”get region(): Region;The region the VM runs in, ready to pass to Sandbox.adopt.
Returns
Section titled “Returns”Methods
Section titled “Methods”agentToken()
Section titled “agentToken()”agentToken(): string;The VM’s bearer credential; store it only privately.
Returns
Section titled “Returns”string
toObject()
Section titled “toObject()”toObject(): DetachedObject;Every field, token included, for a private encrypted store.
Returns
Section titled “Returns”toString()
Section titled “toString()”toString(): string;The record without its secret.
Returns
Section titled “Returns”string
Provenance
Section titled “Provenance”This page is generated from bindings/microvms-js/index.d.ts by TypeDoc 0.28.20 and typedoc-plugin-markdown 4.13.1, run from site/scripts/gen-reference.mjs on every pnpm run sync, so an edit made here is overwritten by the next run.
To change the page, change the doc comment in the binding’s Rust source, then regenerate the declarations with mise run dts. mise run dts:check fails when the committed file no longer matches the source.