Hanzo
OpenapiShare

Enable provisions the caller org's tunnel account and returns the credential…

Enable provisions the caller org's tunnel account and returns the credential the `hanzo share` CLI needs to run a tunnel.

POST /v1/share/enable

Addresshttps://api.hanzo.ai/v1/share/enable
MethodPOST
Operationpost_share_enable
AuthAuthorization: Bearer $HANZO_API_KEY

Enable provisions the caller org's tunnel account and returns the credential the hanzo share CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN org's account. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.

Request

The document declares no body for POST /v1/share/enable. The handler is typed in cloud but its shape is not yet emitted, so the fields are not listed here — ask the MCP door's describe for post_share_enable, which answers from the running route.

Response

StatusBodyMeaning
200enableRespok

200 body — 4 fields.

FieldInTypeAlwaysDescription
accountTokenbodystringAccountToken is the org's own tunnel-account credential.
controllerbodystringController is the public controller endpoint the CLI enables against.
namespacebodystringNamespace is the public frontend a share is published into, when the deployment names one.
urlTemplatebodystringURLTemplate is the shape a share token expands to, so the CLI can print the resulting URL without asking again.

Failure carries the platform error shape — see Errors.

Examples

hanzo share enable

Share API · All Hanzo APIs · Interactive reference

How is this guide?

On this page