Cancel Batch

The Cancel Batch API is called while uploading files to cancel a batch upload. Note that in some cases it may not be possible to cancel a batch upload. Use the returned state to check the new batch state.

Method URL	PUT http://<zapi_url>:<zapi_port>/api/v2/batch/<batch_id>
HTTP Method	PUT
Content Type	application/json
Required Headers	Authorization (set to ZAPI token)

Request Arguments

Arguments	Data Type	How To Use
cancel	bool	Set to true

Response Payload

Optional Arguments	Data Type	How To Use
batch_id	string
state	state	The new state

Example Request Payload

{
   "cancel" : true
}

Example Response Payload

{
     "batch_id" : "b1cc71aef9989ead80012ac",
     "state" : "Cancelled"
}