Skip to content
SYLVE

Validate a guest migration

GET
/tasks/migration/validate
curl --request GET \
  --url 'https://sylve.lan:8181/api/tasks/migration/validate?guestType=vm&guestId=1&targetNodeUuid=example' \
  --header 'Authorization: <Authorization>'

Run a side-effect-free migration preflight for one VM or jail and target node UUID

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
guestType
required
string
Allowed values: vm jail

Guest type

guestId
required
integer
>= 1

Positive guest ID

targetNodeUuid
required
string

Target cluster node UUID

Responses

Section titled “Responses”

200

Section titled “200”

Validation complete

Media typeapplication/json
object
data
object
allowed
boolean
reasons
Array<string>
warnings
Array<string>
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "allowed": true,
    "reasons": [
      "example"
    ],
    "warnings": [
      "example"
    ]
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}