Skip to content

migration_plan.vps_migration

VPS migrations

Create

Path
POST /v7.0/migration_plans/{migration_plan_id}/vps_migrations
Description
Schedule VPS migration
Authentication required
yes
Scope
migration_plan.vps_migration#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
vps_migration
ParameterTypeRequiredDetails
vps
VPS
 Resource yes
dst_node
Dst_node
 Resource yes
maintenance_window
Maintenance_window
 Boolean no

Default: true
cleanup_data
Cleanup_data
 Boolean no

Default: true

Output parameters

Layout
object
Namespace
vps_migration
ParameterTypeDescription
id
Id
 Integer
state
State
 String
transaction_chain
TransactionChain
 Resource
src_node
Src_node
 Resource
vps
VPS
 Resource
dst_node
Dst_node
 Resource
maintenance_window
Maintenance_window
 Boolean
cleanup_data
Cleanup_data
 Boolean
created_at
Created_at
 Datetime
started_at
Started_at
 Datetime
finished_at
Finished_at
 Datetime

Index

Path
GET /v7.0/migration_plans/{migration_plan_id}/vps_migrations
Description
List scheduled VPS migrations
Authentication required
yes
Scope
migration_plan.vps_migration#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
vps_migration
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • queued
  • running
  • cancelled
  • done
  • error

Validation error message: %{value} cannot be used
src_node
Src_node
 Resource no
dst_node
Dst_node
 Resource no

Output parameters

Layout
object_list
Namespace
vps_migrations
ParameterTypeDescription
id
Id
 Integer
state
State
 String
transaction_chain
TransactionChain
 Resource
src_node
Src_node
 Resource
vps
VPS
 Resource
dst_node
Dst_node
 Resource
maintenance_window
Maintenance_window
 Boolean
cleanup_data
Cleanup_data
 Boolean
created_at
Created_at
 Datetime
started_at
Started_at
 Datetime
finished_at
Finished_at
 Datetime

Show

Path
GET /v7.0/migration_plans/{migration_plan_id}/vps_migrations/{vps_migration_id}
Description
Show a migration plan
Authentication required
yes
Scope
migration_plan.vps_migration#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
vps_migration
ParameterTypeDescription
id
Id
 Integer
state
State
 String
transaction_chain
TransactionChain
 Resource
src_node
Src_node
 Resource
vps
VPS
 Resource
dst_node
Dst_node
 Resource
maintenance_window
Maintenance_window
 Boolean
cleanup_data
Cleanup_data
 Boolean
created_at
Created_at
 Datetime
started_at
Started_at
 Datetime
finished_at
Finished_at
 Datetime