Get VM Statistics

GET

/vm/{rid}/stats/{step}

curl --request GET \
  --url https://sylve.lan:8181/api/vm/1/stats/minutely \
  --header 'Authorization: <Authorization>'

Retrieve statistics for a virtual machine

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

Virtual Machine RID

step

required

string

Allowed values: minutely hourly daily weekly monthly yearly

Statistics resolution

Responses

200

Success

Media typeapplication/json

object

data

Array<object>

object

cpuUsage

number

createdAt

string

id

integer

memoryUsage

number

memoryUsed

number

vmId

integer

error

string

message

string

status

string

Example^generated

{
  "data": [
    {
      "cpuUsage": 1,
      "createdAt": "example",
      "id": 1,
      "memoryUsage": 1,
      "memoryUsed": 1,
      "vmId": 1
    }
  ],
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

VM Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}