Skip to content

Give support root access

Allow or revoke Heaven support's root access to a Computer.

Parameters

#
computerstringRequired
Computer name or ID.
statestringRequired
Choose on to allow Heaven support root access or off to revoke it.

Returns

#
dataobjectAlways present
The Computer's support access setting after the change.
Show 1 attributeHide attributes
support_rootbooleanAlways present
Whether Heaven support has Root access to this Computer.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create). Some inputs require sign-in.
  • API key permission: grant-support-root.