Get a simple Virtual Machine by RID

GET

/vm/simple/{rid}

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

Retrieve a simple virtual machine object by its resource ID (RID)

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

>= 1

Virtual Machine RID

Responses

200

Success

Media typeapplication/json

object

data

object

cpuPinning

Array<object>

object

hostCpu

Array<integer>

hostSocket

integer

id

integer

vmId

integer

hasEnabledFilesystemStorage

boolean

id

integer

name

string

rid

integer

state

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7

vncPort

integer

error

string

message

string

status

string

Example

{
  "data": {
    "state": 0
  }
}

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

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