Cancel a bulk action job
client.emailSecurity.investigate.bulk.cancel.create(stringjobId, CancelCreateParams { account_id } params, RequestOptionsoptions?): CancelCreateResponse { action_params, action_type, created_at, 11 more }
POST/accounts/{account_id}/email-security/investigate/bulk/{job_id}/cancel
Marks the job as cancelled and stops any pending message processing. The job record remains visible in list and detail endpoints.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Cancel a bulk action job
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const cancel = await client.emailSecurity.investigate.bulk.cancel.create(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
);
console.log(cancel.job_id);{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"action_params": {
"destination": "Inbox",
"type": "MOVE",
"expected_disposition": "MALICIOUS"
},
"action_type": "MOVE",
"created_at": "2019-12-27T18:11:19.117Z",
"job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"messages_failed": 0,
"messages_pending": 0,
"messages_successful": 0,
"search_params": {
"action_log": true,
"alert_id": "alert_id",
"delivery_status": "delivered",
"detections_only": true,
"domain": "domain",
"end": "2022-07-25T14:30:00Z",
"exact_subject": "exact_subject",
"final_disposition": "MALICIOUS",
"message_action": "PREVIEW",
"message_id": "message_id",
"metric": "metric",
"query": "query",
"recipient": "recipient",
"sender": "sender",
"start": "2022-06-25T14:30:00Z",
"subject": "subject",
"submissions": true
},
"status": "PENDING",
"total_messages_discovered": 0,
"comment": "comment",
"completed_at": "2019-12-27T18:11:19.117Z",
"started_at": "2019-12-27T18:11:19.117Z",
"status_message": "status_message"
},
"success": true
}Returns Examples
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"action_params": {
"destination": "Inbox",
"type": "MOVE",
"expected_disposition": "MALICIOUS"
},
"action_type": "MOVE",
"created_at": "2019-12-27T18:11:19.117Z",
"job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"messages_failed": 0,
"messages_pending": 0,
"messages_successful": 0,
"search_params": {
"action_log": true,
"alert_id": "alert_id",
"delivery_status": "delivered",
"detections_only": true,
"domain": "domain",
"end": "2022-07-25T14:30:00Z",
"exact_subject": "exact_subject",
"final_disposition": "MALICIOUS",
"message_action": "PREVIEW",
"message_id": "message_id",
"metric": "metric",
"query": "query",
"recipient": "recipient",
"sender": "sender",
"start": "2022-06-25T14:30:00Z",
"subject": "subject",
"submissions": true
},
"status": "PENDING",
"total_messages_discovered": 0,
"comment": "comment",
"completed_at": "2019-12-27T18:11:19.117Z",
"started_at": "2019-12-27T18:11:19.117Z",
"status_message": "status_message"
},
"success": true
}