Parameters
#computerstring
Computer name or ID. Omit to list accessible Computers.
patternstring
Computer name filter, such as web-*.
poolstring
Only the Computers in this pool (name or ID).
tagstring
Only the Computers with this tag.
statesstring[]
List Computers in any of the given states, such as running, stopped or failed.
limitstring
Maximum Computers per page in name order. MCP defaults to 100. Use the returned next value with
after for more matches.afterstring
Computer name to list after, in name order. Use the previous page's next value.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
scope_poolsstring[]
Pool name or ID to include in a preview of an API key's resource scope. Combine with other scope filters to preview the union.
scope_computersstring[]
Computer name or ID to include in a preview of an API key's resource scope.
scope_tagsstring[]
Tag whose Computers to include in a preview of an API key's resource scope.
Returns
#dataobjectAlways present
Accessible Computers, or one Computer with requested details and recent operations.
Show 2 attributesHide attributes
alternative-1object
Computers you can access in the selected scope.
Show 4 attributesHide attributes
computersobject[] | nullAlways present
Visible Computers and their reported state, by name: a page of them when
limit or after asks for one.Show 1 attributeHide attributes
itemsobject
A Computer's identity, access and reported state.
Show 21 attributesHide attributes
accessstringAlways present
Your access role.
commandsstring[]
Management commands permitted by your share. May be omitted.
created_atstring (date-time)Always present
When the Computer was created.
disk_used_bytesinteger
Last measured disk use in bytes; absent if unknown. May be omitted.
healthobject
Current access-health diagnosis, when available. May be omitted.
Show 3 attributesHide attributes
detailstring
An explanation of the access problem. May be omitted.
reasonstring
A short explanation of the health state. May be omitted.
sshstring
Reported SSH access health. May be omitted.
idstringAlways present
Computer's stable ID.
imagestring
Template image version. May be omitted.
image_sourceobject
Source registry image. May be omitted.
Show 3 attributesHide attributes
auth_requiredboolean
Whether retrieving the image required registry credentials. May be omitted.
automatic_diskboolean
Whether Heaven chose the disk size to fit the image. May be omitted.
referencestringAlways present
Original registry image reference.
namestringAlways present
Its current name.
owner_emailstring
Owner's email for a shared Computer. May be omitted.
pause_reasonstring
Why the Computer is paused. May be omitted.
poolstringAlways present
Its pool's name.
pool_idstringAlways present
Its pool's ID.
sharingobject
Sharing counts and website access for the owner. May be omitted.
Show 4 attributesHide attributes
linksintegerAlways present
Number of share links.
peopleintegerAlways present
Number of people with sharing access.
publicbooleanAlways present
Whether the website is public.
website_accessstringAlways present
Website access level. Values:
"private", "organization", "public".sizeobjectAlways present
Reported CPU, RAM and disk size.
Show 3 attributesHide attributes
disk_bytesintegerAlways present
Logical disk size in bytes.
memory_mibintegerAlways present
Memory size in mebibytes.
vcpusintegerAlways present
Computer's vCPU count.
ssh_deststring
SSH destination in
NAME@DOMAIN form. May be omitted.statestringAlways present
State derived from requested changes and the latest observation. Values:
"checking", "creating", "degraded", "deleting", "failed", "held", "image_failed", "moving", "paused", "preparing_image", "resetting", "restarting", "running", "starting", "stopped", "stopping", "unknown".state_messagestring
State explanation and required action. May be omitted.
tagsstring[]
Tags currently assigned to the Computer. May be omitted.
urlstring
Main website URL. May be omitted.
website_listeningboolean
Whether the website port accepted a connection at the last check. Absent before a report. May be omitted.
groupstring
Selected grouping for this list. May be omitted.
nextstring
The
after of the next page. Absent on the last page. May be omitted.totalintegerAlways present
How many Computers the filters match, on every page.
alternative-2object
A Computer's state, recent operations and requested details.
Show 10 attributesHide attributes
accessobject
Sharing and website permissions. May be omitted.
Show 15 attributesHide attributes
computerstringAlways present
Computer name.
default_portintegerAlways present
Image's default website port. Zero means none is known.
domainsstring[] | nullAlways present
Custom domain names assigned to this Computer.
grantsobject[] | nullAlways present
People with access and how it was granted.
Show 1 attributeHide attributes
itemsobject
A person's access grant on a Computer.
Show 11 attributesHide attributes
commandsstring[]
Additional management commands this grant permits. May be omitted.
emailstringAlways present
Recipient's email address.
granted_atstring (date-time)Always present
When access was granted.
granted_bystringAlways present
Person who granted access.
link_idstring
Share link that granted access, when applicable. May be omitted.
namestring
Recipient's display name, when set. May be omitted.
noticestring
Latest sharing email status. May be omitted.
picturestring
Recipient's profile picture URL. May be omitted.
rolestringAlways present
Access role. Root permits guest access; ownership is separate.
user_idstringAlways present
Recipient's user ID.
viastringAlways present
How this access was granted.
invitationsobject[] | nullAlways present
Outstanding or recorded email invitations for this Computer.
Show 1 attributeHide attributes
itemsobject
An email invitation to access a Computer.
Show 9 attributesHide attributes
commandsstring[] | nullAlways present
Additional commands the invitation grants.
emailstringAlways present
Invited email address.
expires_atstring (date-time)Always present
When the invitation expires.
idstringAlways present
Invitation ID.
invited_atstring (date-time)Always present
When the invitation was sent.
invited_bystringAlways present
Who sent the invitation.
noticestring | nullAlways present
Latest invitation email's state, or null without a recorded notice.
rolestringAlways present
Role granted when the invitation is accepted.
statestringAlways present
Invitation's current state.
linksobject[] | nullAlways present
Claimable share links and their current states.
Show 1 attributeHide attributes
itemsobject
A share link's metadata.
Show 8 attributesHide attributes
created_atstring (date-time)Always present
When it was created.
created_bystringAlways present
Who created the link.
expires_atstring (date-time) | nullAlways present
When it expires, or null without expiry.
idstringAlways present
Link ID used for removal.
labelstringAlways present
Label identifying the link.
max_usesinteger | nullAlways present
Claim limit, or null without a limit.
statestringAlways present
Whether the link is still claimable or has ended.
usesintegerAlways present
Claims already made through the link.
portintegerAlways present
Selected website guest port. Zero uses the image default.
portsobject[] | nullAlways present
Published public ports for the Computer.
Show 1 attributeHide attributes
itemsobject
A public port forwarding traffic to a Computer.
Show 7 attributesHide attributes
addressstringAlways present
Public connection address.
computer_idstringAlways present
Computer ID.
guest_portintegerAlways present
Destination port inside the Computer.
namestringAlways present
Computer name.
organizationstring
Computer's organization, when applicable. May be omitted.
portintegerAlways present
Public port to connect to.
published_atstring (date-time)Always present
When the port was published.
publicbooleanAlways present
Whether anyone can open the main website.
support_rootbooleanAlways present
Whether Heaven support has Root access.
team_commandsstring[]
Additional commands granted to the whole organization. May be omitted.
team_rolestring
Share role granted to the whole organization. May be omitted.
teamsobject[] | nullAlways present
Shares granted to individual organization teams.
Show 1 attributeHide attributes
itemsobject
A Computer share granted to an organization team.
Show 5 attributesHide attributes
commandsstring[] | nullAlways present
Additional commands granted to the team.
granted_atstring (date-time)Always present
When the share was granted.
granted_bystringAlways present
Who granted the share.
rolestringAlways present
Team's share role on this Computer.
teamstringAlways present
Recipient team's name.
urlstringAlways present
Its main website URL.
website_accessstringAlways present
Who can open the website: private grantees, the organization or the public. Values:
"private", "organization", "public".addressesobject
Computer's address and route information. May be omitted.
Show 6 attributesHide attributes
domainsobject[] | nullAlways present
Custom names served from their own ports.
Show 1 attributeHide attributes
itemsobject
A custom name served from its own guest port.
Show 2 attributesHide attributes
namestringAlways present
Domain name.
portintegerAlways present
Destination guest port.
managerobjectAlways present
Who manages these addresses.
Show 1 attributeHide attributes
namestringAlways present
Manager's name.
portsobject[] | nullAlways present
Published public ports.
Show 1 attributeHide attributes
itemsobject
A public port forwarding to the Computer.
Show 3 attributesHide attributes
addressstringAlways present
Public address to connect to.
guest_portintegerAlways present
Destination port inside the Computer.
portintegerAlways present
Public port number.
public_atstring[] | nullAlways present
Public routes to this Computer through other Computers. Empty when its own website is public.
rangeobjectAlways present
Address pattern and port range for development websites.
Show 3 attributesHide attributes
addressstringAlways present
Development website address pattern.
fromintegerAlways present
First supported guest port.
tointegerAlways present
Last supported guest port.
websiteobjectAlways present
Main website's address, access and last connection check.
Show 4 attributesHide attributes
accessstringAlways present
Who is permitted to open the website. Values:
"private", "organization", "public".addressstringAlways present
Website's URL.
listeningboolean | nullAlways present
Whether the guest port accepted a connection at the last check. Null if unreported or the Computer is stopped.
portintegerAlways present
Guest port served, or zero while none is known.
computerobjectAlways present
Computer's saved settings and latest observation.
Show 26 attributesHide attributes
accessstringAlways present
Your access role.
account_idstringAlways present
Account that holds the Computer.
commandsstring[]
Management commands permitted by your share. May be omitted.
computerobjectAlways present
Saved Computer identity and requested settings.
Show 15 attributesHide attributes
commentstring
Saved comment. May be omitted.
created_atstring (date-time)Always present
When the Computer was created.
desired_powerstringAlways present
Requested power state, which can differ from the observed state.
frozen means paused. Values: "frozen", "running", "stopped".idstringAlways present
Stable Computer ID.
imagestringAlways present
Selected image version.
image_digeststring
Resolved immutable image digest, when available. May be omitted.
image_sourceobject
Original registry image reference, when applicable. May be omitted.
Show 3 attributesHide attributes
auth_requiredboolean
Whether retrieving the image required registry credentials. May be omitted.
automatic_diskboolean
Whether Heaven chose the disk size to fit the image. May be omitted.
referencestringAlways present
Original registry image reference.
lifecyclestringAlways present
Whether the Computer is active or being deleted. Values:
"active", "deleting".login_userstringAlways present
User selected for guest login.
namestringAlways present
Current Computer name.
networkobjectAlways present
Computer's private network address.
Show 1 attributeHide attributes
ipv4stringAlways present
Private IPv4 address.
pool_idstringAlways present
Pool providing this Computer's capacity.
root_volumeobjectAlways present
Disk's reported size.
Show 1 attributeHide attributes
size_bytesintegerAlways present
Disk's logical size in bytes.
shapeobjectAlways present
Saved CPU and memory settings.
Show 2 attributesHide attributes
memory_mibintegerAlways present
Memory size in mebibytes.
vcpusintegerAlways present
Computer's vCPU count.
tagsstring[]
Saved tags. May be omitted.
diskobject | nullAlways present
Last disk measurement, or null before a report.
Show 1 attributeHide attributes
alternative-1object
The Computer's latest disk measurement.
Show 5 attributesHide attributes
reported_atstring (date-time)
When the disk was measured. May be omitted.
size_bytesintegerAlways present
Logical disk size in bytes.
snapshot_bytesinteger
Storage used by this Computer's snapshots, in bytes. May be omitted.
sourcestringAlways present
Measurement source:
guest, host or unknown.used_bytesinteger
Measured disk use in bytes, when available. May be omitted.
endpoint_problemstring
Why guest access is unavailable, when a problem is known. May be omitted.
healthobject
Current guest-access diagnosis. May be omitted.
Show 3 attributesHide attributes
detailstring
An explanation of the access problem. May be omitted.
reasonstring
A short explanation of the health state. May be omitted.
sshstring
Reported SSH access health. May be omitted.
observation_stalebooleanAlways present
Whether the observation is outdated.
owner_emailstring
Owner's email, when visible. May be omitted.
owner_idstringAlways present
Computer owner's ID.
owner_namestring
Who shared the Computer with you, by name: its owner's, or the owning team's or organization's. May be omitted.
pause_reasonstring
Why the Computer is paused. May be omitted.
pool_namestring
Computer's pool name. May be omitted.
received_atstring | nullAlways present
When Heaven received that report, or null before one arrived.
sharingobject
Computer's sharing summary. May be omitted.
Show 4 attributesHide attributes
linksintegerAlways present
Number of share links.
peopleintegerAlways present
Number of people with sharing access.
publicbooleanAlways present
Whether the website is public.
website_accessstringAlways present
Website access level. Values:
"private", "organization", "public".sizeobjectAlways present
Reported CPU and memory size.
Show 2 attributesHide attributes
memory_mibintegerAlways present
Memory size in mebibytes.
vcpusintegerAlways present
Computer's vCPU count.
ssh_deststring
SSH destination in
NAME@DOMAIN form. May be omitted.ssh_hoststring
SSH gateway hostname. May be omitted.
ssh_userstring
SSH gateway username selecting this Computer. May be omitted.
statestringAlways present
State derived from saved changes and the latest observation. Values:
"checking", "creating", "degraded", "deleting", "failed", "held", "image_failed", "moving", "paused", "preparing_image", "resetting", "restarting", "running", "starting", "stopped", "stopping", "unknown".state_messagestringAlways present
State explanation and required action.
statusobject | nullAlways present
Latest boot and guest report, or null before a report.
Show 1 attributeHide attributes
alternative-1object
The Computer's latest boot and guest report.
Show 9 attributesHide attributes
boot_started_atstring (date-time)
When the reported boot began. May be omitted.
guestobject
Latest report from inside the Computer. May be omitted.
Show 11 attributesHide attributes
endpoint_reasonstring
Why the guest endpoint cannot currently accept access. May be omitted.
init_errorstring
A reported initialization failure. May be omitted.
kernelstringAlways present
Running guest kernel version.
reported_atstring (date-time)Always present
When the guest made this report.
root_bytesinteger
Reported root filesystem size in bytes. May be omitted.
root_grown_bytesinteger
Disk size the root filesystem last grew to, in bytes. May be omitted.
root_growth_errorstring
Why a requested filesystem increase could not be applied. May be omitted.
root_used_bytesinteger
Reported root filesystem use in bytes. May be omitted.
setup_errorstring
A reported setup-script failure. May be omitted.
setup_runningboolean
Whether the setup script is still running. May be omitted.
statusstring
Guest platform's reported state. May be omitted.
imageobject
Image preparation details and errors. May be omitted.
Show 4 attributesHide attributes
default_portinteger
Website port exposed by the image. May be omitted.
error_codestring
Why image preparation failed, when a failure was recorded. May be omitted.
login_userstring
Image's guest login user. May be omitted.
rootfs_bytesinteger
Prepared image filesystem's size in bytes. May be omitted.
image_progressobject
Image download or preparation progress. May be omitted.
Show 4 attributesHide attributes
download_bytesinteger
Total download bytes when known. May be omitted.
downloaded_bytesinteger
Image bytes downloaded so far. May be omitted.
stagestringAlways present
Whether preparation is waiting, downloading or building. Values:
"building", "downloading", "waiting".unpacked_bytesinteger
Image bytes unpacked so far. May be omitted.
last_exitobject
How and when the Computer last stopped. May be omitted.
Show 2 attributesHide attributes
atstring (date-time)Always present
When the exit occurred.
kindstringAlways present
Reported exit cause, such as shutdown, reboot or crash. Values:
"crashed", "destroyed", "failed", "reboot", "shutdown", "unknown".platform_ready_atstring (date-time)
When the guest platform reported readiness for this boot. May be omitted.
restart_requiredboolean
Whether a restart is required to finish applying a change. May be omitted.
restart_to_updateboolean
Whether restarting would apply a newer platform boot version. May be omitted.
updated_atstring (date-time)Always present
When this observation was updated.
support_rootbooleanAlways present
Whether Heaven support has Root access to this Computer.
urlstring
Computer's main website URL. May be omitted.
usageobject | nullAlways present
Latest usage measurements; null before a report.
Show 1 attributeHide attributes
alternative-1object
The latest usage observation.
Show 4 attributesHide attributes
memory_bytesinteger
Memory attributed to this Computer, in bytes. May be omitted.
observed_atstring (date-time)
When usage was measured. May be omitted.
ratesobject
CPU use over the sample interval. May be omitted.
Show 2 attributesHide attributes
cpu_coresnumberAlways present
Average number of vCPUs in use during the interval.
window_secondsnumberAlways present
Measurement interval in seconds.
statestringAlways present
Measurement availability:
observed for a valid sample, unknown or not_sampled otherwise.websiteobject
Last connection check of the website's port. May be omitted.
Show 1 attributeHide attributes
listeningbooleanAlways present
Whether the website port accepted a connection.
domainsobject[]
Custom names assigned to the Computer. May be omitted.
Show 1 attributeHide attributes
itemsobject
A Computer's domain name and its DNS and certificate status.
Show 18 attributesHide attributes
added_atstring (date-time)Always present
When the name was assigned.
certificate_statestring
HTTPS certificate's current state, when applicable. May be omitted.
computerstringAlways present
Destination Computer's name.
computer_idstringAlways present
Destination Computer's ID.
dns_checked_atstring (date-time) | nullAlways present
When DNS was last checked.
dns_failing_sincestring (date-time) | nullAlways present
When the current DNS failure began.
dns_messagestring | nullAlways present
An explanation of the DNS problem, when present.
dns_reasonstring | nullAlways present
DNS problem code, or null without a recorded problem.
dns_statestringAlways present
Latest DNS-check state.
domainstringAlways present
Registrable domain containing this name.
maintenance_pausedbooleanAlways present
Whether automatic domain maintenance is paused.
namestringAlways present
Full domain name.
pathsobject[] | nullAlways present
Path-specific routes to other Computers.
Show 1 attributeHide attributes
itemsobject
A path under a domain name routed to a Computer.
Show 5 attributesHide attributes
computerstringAlways present
Destination Computer's name.
computer_idstringAlways present
Destination Computer's ID.
pathstringAlways present
URL path prefix to match.
portinteger
Destination port when explicitly selected. May be omitted.
strip_prefixboolean
Whether forwarding removes the matched prefix. May be omitted.
portinteger | nullAlways present
Guest port; null uses the Computer's website setting.
proxiedbooleanAlways present
Whether Cloudflare's proxy sits in front of the name.
redirectstringAlways present
Redirect destination, when this name redirects.
unprovenbooleanAlways present
Whether the name is still waiting for DNS proof.
wildcardbooleanAlways present
Whether this is a wildcard name.
mailobject
Computer's mail settings. May be omitted.
Show 5 attributesHide attributes
notestring
Effects of disabling mail reception, returned for that change. May be omitted.
receiving_enabledbooleanAlways present
Whether mail reception is enabled for this Computer.
receiving_reasonstring
Why receiving is disabled or unavailable, when applicable. May be omitted.
reply_policystringAlways present
Permitted reply recipients. Values:
"all", "known", "none", "owner".sending_suspendedbooleanAlways present
Whether outgoing mail is suspended.
operationsobject[] | nullAlways present
Recent operations you are permitted to read.
Show 1 attributeHide attributes
itemsobject
An accepted change to one Computer. Work continues after the request disconnects.
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".portsobject
Published ports and retained port assignments. May be omitted.
Show 3 attributesHide attributes
keptobject[]
Recently released ports, included for Computer-specific reads. Adding the guest port again reclaims its public port. May be omitted.
Show 1 attributeHide attributes
itemsobject
A recently released public port retained for this Computer for 30 days.
Show 4 attributesHide attributes
addressstringAlways present
Address it would be published on now.
guest_portintegerAlways present
Guest port to add again to reclaim this public port.
portintegerAlways present
Retained public port number.
released_atstring (date-time)Always present
When the port was released.
poolsobject[] | nullAlways present
Port availability and usage for each selected pool.
Show 1 attributeHide attributes
itemsobject
A pool's public-port usage and availability.
Show 11 attributesHide attributes
allowedintegerAlways present
Applicable public-port allowance.
heldintegerAlways present
Public ports held by this pool's Computers.
idstringAlways present
Pool ID.
namestringAlways present
Pool name.
new_leftintegerAlways present
New ports available within the rolling 24-hour limit. Reclaimed ports are excluded.
new_next_atstring (date-time)
When the new-port allowance next increases. May be omitted.
offeredbooleanAlways present
Whether the pool has an address on which ports can be published.
organizationstring
Owning organization. May be omitted.
reasonstring
Why publishing is unavailable. May be omitted.
portsobject[] | nullAlways present
Currently published ports.
Show 1 attributeHide attributes
itemsobject
A public port forwarding traffic to a Computer.
Show 7 attributesHide attributes
addressstringAlways present
Public connection address.
computer_idstringAlways present
Computer ID.
guest_portintegerAlways present
Destination port inside the Computer.
namestringAlways present
Computer name.
organizationstring
Computer's organization, when applicable. May be omitted.
portintegerAlways present
Public port to connect to.
published_atstring (date-time)Always present
When the port was published.
snapshotsobject
Snapshots of the Computer's disk. May be omitted.
Show 7 attributesHide attributes
computersobject[] | nullAlways present
Storage that deleting each Computer's snapshots would free: on a page, the Computers of its snapshots.
Show 1 attributeHide attributes
itemsobject
Storage recoverable by deleting a Computer's snapshots together.
Show 3 attributesHide attributes
idstringAlways present
Computer ID.
namestringAlways present
Computer name.
snapshot_bytesstring | nullAlways present
Bytes freed by deleting all this Computer's snapshots, as a decimal string; null if unknown.
nextstring
The
after of the next page. Absent on the last page. May be omitted.observed_atstring (date-time) | nullAlways present
Time of the storage observation, or null when unknown.
poolsobject[] | nullAlways present
Storage use in the pools you can read.
Show 1 attributeHide attributes
itemsobject
A pool's included and used storage. Byte counts are decimal strings; null measurements are unknown.
Show 5 attributesHide attributes
allowance_bytesstring | nullAlways present
Included storage for files and snapshots, in bytes.
files_bytesstring | nullAlways present
Storage used by files, in bytes.
idstringAlways present
Pool ID.
snapshot_bytesstring | nullAlways present
Storage used by snapshots, in bytes.
used_bytesstring | nullAlways present
Files and snapshots together, in bytes.
snapshotsobject[] | nullAlways present
Snapshots matching the request.
Show 1 attributeHide attributes
itemsobject
A point-in-time disk snapshot. Byte counts are decimal strings; null measurements are unknown.
Show 21 attributesHide attributes
automaticbooleanAlways present
Whether Heaven created the snapshot automatically.
changed_since_bytesstring | nullAlways present
Bytes changed since this snapshot.
computerobjectAlways present
Computer whose disk was snapshotted.
Show 2 attributesHide attributes
idstringAlways present
Referenced object's stable ID.
namestringAlways present
Referenced object's name.
copiesobject[] | nullAlways present
Accessible Computers originating from this snapshot, including those later reset or restored.
Show 1 attributeHide attributes
itemsobject
A Computer, pool or snapshot reference.
created_byobjectAlways present
Who requested the snapshot.
Show 2 attributesHide attributes
emailstring | nullAlways present
Their email address, or null when none is available.
user_idstringAlways present
Person's user ID.
data_bytesstring | nullAlways present
Reported snapshot data, in bytes.
data_sourcestring | nullAlways present
Where the data-size measurement came from.
disk_bytesstring | nullAlways present
Logical disk size at capture, in bytes.
expires_atstring (date-time) | nullAlways present
When the snapshot expires. Null keeps it until explicitly deleted.
idstringAlways present
Snapshot ID.
kept_byobject[] | nullAlways present
Snapshots retaining this deleted snapshot. Null unless dependencies delay deletion.
Show 1 attributeHide attributes
itemsobject
A Computer, pool or snapshot reference.
kept_by_computersobject[] | nullAlways present
Accessible copied Computers whose disks still retain this deleted snapshot's data.
Show 1 attributeHide attributes
itemsobject
A Computer, pool or snapshot reference.
kept_by_other_copiesinteger
Number of copied Computers you cannot access that retain this snapshot. May be omitted.
namestringAlways present
Snapshot's name within its Computer.
notestringAlways present
Saved note about this snapshot.
observed_atstring (date-time) | nullAlways present
Time the measurements were last reported.
requested_atstring (date-time)Always present
When snapshot creation was requested.
savedstring | nullAlways present
Disk capture method:
stopped, flushed or unflushed. Flushing does not guarantee application consistency. Null means capture is unreported.size_bytesstring | nullAlways present
Storage unique to this snapshot, in bytes.
statestringAlways present
Snapshot lifecycle state.
pending awaits disk capture.taken_atstring (date-time) | nullAlways present
When the disk snapshot was taken, or null before it has been reported.
stalebooleanAlways present
Whether the measurements are too old to treat as current.
totalintegerAlways present
How many snapshots the list holds, on every page.
withheldstring[]
Requested parts your credential or role cannot read. May be omitted.
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. |
| 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
#- API key permission:
view.