Remove a Virtual Machine

DELETE

/vm/{rid}

curl --request DELETE \
  --url 'https://sylve.lan:8181/api/vm/1?force=false' \
  --header 'Authorization: <Authorization>'

Remove a virtual machine by RID. Set force=true for best-effort forced removal; normal removal requires all three cleanup flags.

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

>= 1

Virtual Machine RID

Query Parameters

deletemacs

boolean

Delete unused VM MAC objects (required for normal removal; defaults to true for forced removal)

deleterawdisks

boolean

Delete raw-disk datasets (required for normal removal)

deletevolumes

boolean

Delete volume datasets (required for normal removal)

force

boolean

Use best-effort forced removal

Responses

200

Success

Media typeapplication/json

object

data

object

deletedMacObjectIds

Array<integer>

retainedDatasets

Array<string>

retainedMacObjectIds

Array<integer>

warnings

Array<string>

error

string

message

string

status

string

Example^generated

{
  "data": {
    "deletedMacObjectIds": [
      1
    ],
    "retainedDatasets": [
      "example"
    ],
    "retainedMacObjectIds": [
      1
    ],
    "warnings": [
      "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"
}

403

Forbidden

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

409

Conflict

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