Parameters
#computerstringRequired
Computer name or ID.
accessstring
Who can open the website.
private removes the organization-wide share and requires another source of access. organization admits signed-in members of the owning organization. public admits anyone. Use this field or public.publicboolean
Set true to let anyone open the website. Set false to require existing access, including any organization-wide grant. Use this field or
access.portstring
HTTP port inside the Computer to serve at its main website address. Use 1 to 65535, except 6080, which serves the Computer's desktop. Use 0 to restore the image's default port.
Returns
#dataobjectAlways present
The Computer's saved website access and port settings.
Show 7 attributesHide attributes
accessstringAlways present
private requires granted access, organization admits the organization, and public admits anyone. Values: "private", "organization", "public".computerstringAlways present
Computer name.
default_portinteger
Image's website port, when known. May be omitted.
portintegerAlways present
Selected guest port. Zero uses the image's default port.
publicbooleanAlways present
Whether the website is publicly accessible.
updatedboolean
Whether this request changed the website settings. May be omitted.
urlstringAlways present
Website's main URL.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| payment_required | 402 | Payment or credit is required. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- CLI:
heaven loginwithHEAVEN_API_KEYunset. MCP: Heaven sign-in. cURL:HEAVEN_SIGN_IN_KEYfrom approved device sign-in (POST /v1/auth/create). Some inputs require sign-in. - API key permission:
website.