Skip to main content
POST
/
plans
/
{plan_id}
/
migrations
/
{migration_id}
/
cancel
Cancel migration
curl --request POST \
  --url https://api.withorb.com/v1/plans/{plan_id}/migrations/{migration_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "plan_id": "<string>",
  "effective_time": "2023-12-25",
  "status": "not_started"
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
plan_id
string
required
​
migration_id
string
required

Response

OK

​
id
string
required
​
plan_id
string
required
​
effective_time
required
​
status
enum<string>
required
Available options:
not_started,
in_progress,
completed,
action_needed,
canceled