Parameters
#computerstring
Computer name or ID.
rangestring
History period: 24h (default), 7d or 30d.
resolutionstring
Interval between usage points. Give 1m, 5m or 1h. This interval takes precedence over
points. When both fields are omitted, one Computer or a pool uses 5m for 24h and 1h for longer ranges. A list of Computers uses 1h.pointsstring
Target maximum number of points per series, from 1 to 1000. A series includes at least one point per day. MCP defaults to 24 points. An explicit
resolution overrides this target.organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
poolstring
Pool name or ID to filter the Computer list. Applies to a list without a named Computer.
Returns
#dataobjectAlways present
One Computer's usage history, or CPU and memory history for accessible Computers in the selected scope.
Show 2 attributesHide attributes
alternative-1object
A Computer's usage history.
Show 4 attributesHide attributes
rangestringAlways present
Selected history range.
resolution_secondsintegerAlways present
Duration of each series interval in seconds.
seriesobject[]Always present
Usage intervals in time order, using summary measures and units.
bucket_start identifies the interval; unmeasured values are omitted.Show 1 attributeHide attributes
itemsobject
Measurements for one interval. Unmeasured values are omitted.
summaryobjectAlways present
Usage over the range; null measurements are unknown.
Show 22 attributesHide attributes
bucket_startstring (date-time)Always present
Start of the interval.
computer_idstringAlways present
Measured Computer's ID.
covered_secondsnumberAlways present
Seconds covered by CPU and memory measurements.
cpu_usecinteger | nullAlways present
CPU time consumed, in microseconds.
cpu_vcpus_avgnumber | nullAlways present
Average vCPUs in use over measured time.
cpu_vcpus_maxnumber | nullAlways present
Peak measured vCPUs in use.
disk_size_bytesinteger | nullAlways present
Logical disk size in bytes.
disk_used_bytesinteger | nullAlways present
Measured disk use in bytes.
egress_bytesinteger
Bytes sent directly to the internet. May be omitted.
front_door_bytesinteger
Bytes sent to visitors through Heaven's front doors. May be omitted.
io_covered_secondsnumberAlways present
Seconds covered by disk I/O measurements.
io_read_bytesinteger | nullAlways present
Bytes read from disk.
io_read_opsinteger | nullAlways present
Disk read operations counted.
io_write_bytesinteger | nullAlways present
Bytes written to disk.
io_write_opsinteger | nullAlways present
Disk write operations counted.
memory_bytes_avgnumber | nullAlways present
Average measured memory use in bytes.
net_covered_secondsnumberAlways present
Seconds covered by network measurements.
net_rx_bytesinteger | nullAlways present
Bytes received by the Computer.
net_tx_bytesinteger | nullAlways present
Bytes sent by the Computer.
pool_idstring
Pool containing the Computer when measured. May be omitted.
runningbooleanAlways present
Whether the Computer was recorded running in the interval.
vcpusintegerAlways present
Recorded vCPU count.
alternative-2object
CPU and memory history for Computers you own or can access as Root in the selected scope.
Show 3 attributesHide attributes
computersobject[] | nullAlways present
A summary and series for each measured Computer.
Show 1 attributeHide attributes
itemsobject
One Computer's CPU and memory history.
Show 4 attributesHide attributes
idstringAlways present
Computer ID.
namestringAlways present
Computer name.
seriesobject[] | nullAlways present
One point per interval since the Computer was created.
Show 1 attributeHide attributes
itemsobject
Average CPU and memory use over an interval. Unmeasured values are omitted.
Show 3 attributesHide attributes
cpu_vcpus_avgnumber
Average vCPUs in use over measured time. May be omitted.
memory_bytes_avgnumber
Average memory use in bytes. May be omitted.
startstring (date-time)Always present
Start of the interval.
summaryobjectAlways present
Average measured usage over the selected range.
Show 3 attributesHide attributes
cpu_vcpus_avgnumber
Average vCPUs in use over measured time. May be omitted.
memory_bytes_avgnumber
Average memory use in bytes. May be omitted.
startstring (date-time)Always present
Start of the interval.
rangestringAlways present
Selected history range.
resolution_secondsintegerAlways present
Duration of each series interval in seconds.
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:
usage.