Skip to content

Set your default setup script

Set the personal setup script for fresh Computers you create without their own script. It runs on first boot after any pool setup script, as the image's login user.

Parameters

#
setup_scriptstringRequired
Shell script for new Computers, from 1 byte to 10 KiB. An explicit setup script on a Computer takes precedence. Treated as a secret and never included in errors.

Returns

#
dataobjectAlways present
A saved setting.
Show 1 attributeHide attributes
updatedbooleanAlways present
Whether the request saved the setting.

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).
  • A key limited to a command list cannot run this command.