Skip to content

Delete Computers

Delete Computers and their disks and snapshots without a confirmation prompt. If a backup exists, Heaven support can restore the Computer for 7 days. The result includes each Computer's backup availability and recovery deadline. Changes since the backup can be lost.

Parameters

#
computersstring[]Required
Names or IDs of Computers whose disks and snapshots to delete.

Returns

#
dataobjectAlways present
Computer deletion results and recovery information.
Show 3 attributesHide attributes
recoverystring
Effects of deletion on disks, snapshots, addresses and name retention. May be omitted.
request_idstringAlways present
Request ID for this deletion.
resultsobject[] | nullAlways present
Each Computer's deletion operation or refusal.
Show 1 attributeHide attributes
itemsobject
One Computer's deletion result.
Show 4 attributesHide attributes
backupobject
Whether an existing backup can support recovery and its deadline. May be omitted.
Show 3 attributesHide attributes
backup_atstring (date-time)
When the available backup was taken. May be omitted.
restorablebooleanAlways present
Whether a restorable backup was found.
untilstring (date-time)
Deadline for recovery from the retained backup. May be omitted.
computerobjectAlways present
Computer selected for deletion.
Show 2 attributesHide attributes
idstringAlways present
Computer ID.
namestringAlways present
Computer's name when this result was prepared.
errorobject
Why deletion was refused for this Computer. May be omitted.
Show 7 attributesHide attributes
actionobject
A suggested command addressing the problem. May be omitted.
Show 2 attributesHide attributes
commandstringAlways present
Command's catalog name.
linestringAlways present
Complete suggested command line.
kindstringAlways present
Error category. unknown means the effect is uncertain; reconcile before retrying.
messagestringAlways present
What happened and any action needed from you.
operation_idstring
Operation to read before repeating uncertain work. May be omitted.
request_idstring
Request ID identifying the change during reconciliation. May be omitted.
retry_afterinteger
Seconds before retrying a rate-limited request or a refused wait. May be omitted.
urlstring
Payment page for a payment-required response. May be omitted.
operationobject
Its deletion operation, when accepted. May be omitted.
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".

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: delete.