Operator

Cancel an unfinished import of any organization: the customer's own cancel path (temporary access and copies are cleaned up), audited with the admin as actor; an import that already ended is a replay

post/operator/migrations/{migrationId}/cancel

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/operator/migrations/{migrationId}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

migrationIdstring uuid required

Request body

reasonstring required

required: shown in the audit log verbatim

Response

Canceled, or the cancel requested from the running step

status'ok' required
statestring required
cancelRequestedboolean required
replayboolean required

true when the import had already ended: nothing changed

Changes

No recorded changes to this operation across all 1 revision of this API.