Skip to content

Resize a Computer

Change a Computer's CPU, memory or disk size without restarting it. CPU and memory must fit in the pool. A disk can only grow, within the pool's storage allowance.

Parameters

#
computerstringRequired
Computer name or ID.
cpustring
New CPU size in whole vCPUs up to the pool's allocation, or pool to follow its CPU size. Omit to keep the current setting.
memorystring
New memory size up to the pool's allocation, such as 8GiB, or pool to follow its memory size. G, GB and GiB mean GiB for memory. Omit to keep the current setting.
diskstring
New disk size, greater than the current size and at most the pool's storage allocation. Use GB for decimal units or GiB for binary units.
waitboolean or string
Wait for the operation to finish. Use true for up to 10m or give a shorter duration such as 2m. Accepted work continues after the wait ends.

Returns

#
dataobjectAlways present
An operation and its request ID.
Show 8 attributesHide attributes
namestring
Computer's name after creation, copying or reset. May be omitted.
notesstring[]
Other effects, including settings or integrations excluded from a copy. May be omitted.
operationobjectAlways present
Current operation state.
Show 9 attributesHide attributes
bystring
Requester's email address, or user ID if no email is recorded. Omitted for your own requests. May be omitted.
completed_atstring (date-time)
When the operation reached its final state. Absent while unfinished. May be omitted.
computer_idstringAlways present
Computer's stable ID.
created_atstring (date-time)
When Heaven accepted the change. May be omitted.
error_codestring
Recorded failure code. May be omitted.
idstringAlways present
Operation ID for operation view.
kindstringAlways present
Change being tracked.
messagestring
An explanation of the recorded failure and any next action. May be omitted.
statestringAlways present
accepted means saved and unfinished. complete means the change finished. failed means it could not finish. superseded means a newer change replaced it before completion. Values: "accepted", "complete", "failed", "superseded".
pool_notestring
How stopping this Computer affects its pool. May be omitted.
renamedobject
Addresses affected by a rename. May be omitted.
Show 6 attributesHide attributes
httpsstringAlways present
Website URL using the new name.
mailstringAlways present
Domain under which the Computer receives mail.
namesobject[]
Custom names created with the Computer and whether they followed its rename. May be omitted.
Show 1 attributeHide attributes
itemsobject
A custom name affected by a Computer rename.
Show 3 attributesHide attributes
fromstringAlways present
Previous custom name.
movedbooleanAlways present
Whether the name moved. False means the destination was occupied and the old custom name was retained.
tostringAlways present
Name corresponding to the Computer's new name.
notestringAlways present
What happened to old addresses and when the guest hostname changes.
portsstring[]
Published port addresses that use the new name. May be omitted.
sshstringAlways present
SSH command using the new name.
request_idstringAlways present
Request ID identifying this change across retries.
ssh_deststring
SSH destination in NAME@DOMAIN form. May be omitted.
urlstring
Computer's website address. May be omitted.

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

#
  • API key permission: resize.