You use the /bulkexport/cancel endpoint to stop an in-progress bulk export identified by ID.

Request

You must specify the export UID from the submit request to cancel that request.

POST /bulkexport/cancel  
{  
  "id": "{TRACKING UID}"  
}

Request Example

A sample curl command to cancel a bulk export job follows. This example shows values for the AWS region, and the ChaosSearch API key for authentication, and an export ID:

curl 'https://mycompany.chaossearch.com/bulkexport/cancel' \
--aws-sigv4 "aws:amz:<region>:s3" --user "<API_Key>:<Secret>" \
  -H 'Content-Type: application/json' \
  --data-raw '{"id":"5b00d97d-133d-48e7-9e61-a8a98e4d0a38"}'

Response

The status response contains information when there is a successful cancellation.

{"status":"Successfully cancelled"

RBAC Controls

To submit a bulk export cancel request, you must be granted permission via a permission block with the chaos:query:export:cancel action. Additionally, an optional condition constraint may be included to restrict cancel operations to only the jobs submitted by a specific user (for instance, the current user).

{  
  "Actions": [  
    "chaos:query:export:cancel"  
  ],  
  "Condition": {  
    "Conditions": [  
      {  
        "Equals": {  
          "chaos:owner/crn": "${chaos:principal/crn}"  
        }  
      }  
    ]  
  },  
  "Effect": "Allow",  
  "Resources": [  
    "*"  
  ],  
  "Version": "1.0"  
}