Batches

Cancel a batch

Changed on

Cancel a batch job that is currently pending or running.

Once cancelled, no new assets will be processed. Assets currently being processed may complete. The batch status will be updated to 'cancelled'.

Cannot cancel batches that are already completed, failed, or cancelled.

post/batch/{batchId}/cancel

Request

  • Base URL: https://run-workflow.adobe.io
  • URL: https://run-workflow.adobe.io/batch/{batchId}/cancel
  • Auth: HTTP bearer and API key in header x-api-key

Path parameters

batchIdstring required

Batch identifier.

Headers

api-version'1.0'

Public API contract version for batch operations (/batch/…, GET /batches). The supported value is 1.0. If omitted, the service assumes 1.0. Unsupported values return 400 with status: "error".

x-gw-ims-org-idstring required

IMS organization ID for the authenticated caller. Scopes every request to that organization.

x-gw-ims-user-idstring required

IMS user ID for the authenticated caller.

Response

Success

batchIdstring
status'cancelled'
messagestring
previousStatusstring

Changes

  • db6f373f16f0Revision changes
    • breaking

      added the new required header request parameter x-gw-ims-org-id

    • breaking

      added the new required header request parameter x-gw-ims-user-id

    • info

      the endpoint scheme security BearerAuth AND ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      added the non-success response with the status

  • 995d308ddc56Revision changes
    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      api tag Batches added

    • info

      added the new optional header request parameter api-version