Skip to content

migration_plan

View migration plans

Cancel

Path
POST /v7.0/migration_plans/{migration_plan_id}/cancel
Description
Cancel execution of a migration plan
Authentication required
yes
Scope
migration_plan#cancel
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
migration_plan
ParameterTypeDescription
id
Id
 Integer
state
State
 String
stop_on_error
Stop_on_error
 Boolean
send_mail
Send_mail
 Boolean
concurrency
Concurrency
 Integer How many migrations run concurrently
reason
Reason
 String
user
User
 Resource
created_at
Created_at
 Datetime
finished_at
Finished_at
 Datetime

Create

Path
POST /v7.0/migration_plans
Description
Create a custom migration plan
Authentication required
yes
Scope
migration_plan#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
migration_plan
ParameterTypeRequiredDetails
stop_on_error
Stop_on_error
 Boolean no

Default: true
send_mail
Send_mail
 Boolean no

Default: true
concurrency
Concurrency
 Integer no

How many migrations run concurrently

Default: 10

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

Validation error message: must be at least 1
reason
Reason
 String no

Default: null

Output parameters

Layout
object
Namespace
migration_plan
ParameterTypeDescription
id
Id
 Integer
state
State
 String
stop_on_error
Stop_on_error
 Boolean
send_mail
Send_mail
 Boolean
concurrency
Concurrency
 Integer How many migrations run concurrently
reason
Reason
 String
user
User
 Resource
created_at
Created_at
 Datetime
finished_at
Finished_at
 Datetime

Delete

Path
DELETE /v7.0/migration_plans/{migration_plan_id}
Description
Delete staged migration plan
Authentication required
yes
Scope
migration_plan#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/migration_plans
Description
List migration plans
Authentication required
yes
Scope
migration_plan#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
migration_plan
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:

  • staged
  • running
  • cancelling
  • failing
  • cancelled
  • done
  • error

Validation error message: %{value} cannot be used
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
migration_plans
ParameterTypeDescription
id
Id
 Integer
state
State
 String
stop_on_error
Stop_on_error
 Boolean
send_mail
Send_mail
 Boolean
concurrency
Concurrency
 Integer How many migrations run concurrently
reason
Reason
 String
user
User
 Resource
created_at
Created_at
 Datetime
finished_at
Finished_at
 Datetime

Show

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

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
migration_plan
ParameterTypeDescription
id
Id
 Integer
state
State
 String
stop_on_error
Stop_on_error
 Boolean
send_mail
Send_mail
 Boolean
concurrency
Concurrency
 Integer How many migrations run concurrently
reason
Reason
 String
user
User
 Resource
created_at
Created_at
 Datetime
finished_at
Finished_at
 Datetime

Start

Path
POST /v7.0/migration_plans/{migration_plan_id}/start
Description
Begin execution of a migration plan
Authentication required
yes
Scope
migration_plan#start
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
migration_plan
ParameterTypeDescription
id
Id
 Integer
state
State
 String
stop_on_error
Stop_on_error
 Boolean
send_mail
Send_mail
 Boolean
concurrency
Concurrency
 Integer How many migrations run concurrently
reason
Reason
 String
user
User
 Resource
created_at
Created_at
 Datetime
finished_at
Finished_at
 Datetime

Subresources