Skip to navigation
API Referencevms

Get usage history metrics for a virtual machine

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Path parameters

idstringRequired
ID of the virtual machine

Query parameters

hoursdoubleRequired

Number of hours to look back (1-16)

sample_perioddoubleOptional

Sampling step — return every Nth data point from the raw dataset. Higher values return fewer, more spread-out points. When omitted, up to 150 points are returned.

Response

Time-series usage samples for the virtual machine.

timestampdatetime
Sample timestamp from the underlying compute platform.
cpuUsagePctdouble

CPU usage as a percentage (0–100), rounded to two decimal places.

memoryUsagePctdouble

Memory usage as a percentage (0–100), rounded to two decimal places.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error