Integrations

Cancel Migration

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.

post/integrations/migrations/{migration_id}/cancel

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/integrations/migrations/{migration_id}/cancel
  • Auth: HTTP bearer

Path parameters

migration_idstring required

Migration id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataConnectionPayload 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".

Changes

No recorded changes to this operation across all 2 revisions of this API.