Cancel Scan Batch

Url

/file/batch/<batch_id>/cancel

Method

POST

When cancelling a batch, the connected scans that are still in progress will be cancelled also. The cancelled batch will be closed.

Header

Description

apikey (OPTIONAL)

User's session id, if it was set for creation it is required

Result Code

Description

200

Batch cancelled successfully

400

Bad request, (e.g.: wrong header values)

403

Access denied

404

Batch not found

500

Internal server error

HTTP status code: 200

{
[batch_id]: "cancelled"
}

HTTP status code: 500, 403, 400

{
"err": <error message>
}