Manage

Cancel bulk process

Cancels the bulk process identified by the bulk_id parameter, leaving it in CANCELLED.

The process must be RUNNING or PAUSED, or the request fails with INVALID_STATE.

:::note CANCELLED is a final state. A canceled process can't be resumed or re-executed. You would need to create a new bulk process for the remaining work. :::

Canceling stops further operations from starting. It does not roll back operations that have already executed. Use List bulk operations to see which ones ran before the cancellation. To stop a run temporarily instead, use Pause bulk process.

post/bulks/{bulk_id}/cancel

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/bulks/{bulk_id}/cancel
  • Auth: HTTP bearer and API key in header api-key

Path parameters

bulk_idstring required
Example:2468013579

The bulk id of the bulk process.

Response

Success - No Content.

Changes

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