Get a Virtual Machine's Domain

GET

/vm/{rid}/domain

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

Retrieve the domain information of a virtual machine by its RID

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

Virtual Machine RID

Responses

200

Success

Media typeapplication/json

object

data

object

id

integer

name

string

overrideRequested

boolean

pendingAction

string

status

string

uuid

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "id": 1,
    "name": "example",
    "overrideRequested": true,
    "pendingAction": "example",
    "status": "example",
    "uuid": "example"
  },
  "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

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

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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