Cancel Migration
POST /integrations/migrations/{migration_id}/cancel
POST
/integrations/migrations/{migration_id}/cancel
Stop a running migration.
Records already imported STAY - this stops the import, it does not undo
it. The status goes to cancelling rather than cancelled, because work
already in flight has to finish first.
Authorizations
Parameters
Path Parameters
migration_id
required
Migration id.
string
Migration id.
Header Parameters
Responses
200
Successful Response
object
data
required
An open envelope for a connection, a token or a migration report.
Open because the migration STATUS payload carries a per-entity progress map, a discovered-field map and a pipeline list that all grow with the providers - and because a dropped warning on a migration report reads as “nothing went wrong”.
object
key
additional properties
any
pagination
Any of:
object
has_next
required
Whether there are more pages
boolean
limit
required
Items per page
integer
notes
Any of:
Array<string>
null
page
required
Current page number (1-indexed)
integer
total
required
Total number of items
integer
null
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string