Get Initial VM Statistics

GET

/vm/{rid}/stats

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

Retrieve the finest available statistics window and its availability metadata for a virtual machine

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

Virtual Machine RID

Responses

200

Success

Media typeapplication/json

object

data

object

historyState

string

Allowed values: available never-recorded outside-supported-range

lastSampleAt

string

points

Array<object>

object

cpuUsage

number

createdAt

string

id

integer

memoryUsage

number

memoryUsed

number

vmId

integer

resolvedStep

string

Allowed values: minutely hourly daily weekly monthly yearly

error

string

message

string

status

string

Example

{
  "data": {
    "historyState": "available",
    "resolvedStep": "minutely"
  }
}

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"
}