asyncTask

Get all asyncTasks

Securityapi_key
Request
query Parameters
operation
string

The operation type for which to get async tasks.

Enum: "ALGORITHM_CREATE" "ALGORITHM_MIGRATE" "ALGORITHM_UPDATE" "EXPORT" "IMPORT" "RULESET_REFRESH" "SUPPORT_BUNDLE_GENERATE" "TABLE_BULK_UPDATE"
status
string

The status type for which to get async tasks.

Enum: "CANCELLED" "FAILED" "RUNNING" "SUCCEEDED" "WAITING"
page_number
integer <int64>
Default: 1

The page number for which to get asyncTasks. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

400

Bad request

401

Unauthorized access

get/async-tasks
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Get asyncTask by ID

Securityapi_key
Request
path Parameters
asyncTaskId
required
integer <int32>

The ID of the asyncTask to get

Responses
200

Success

401

Unauthorized access

404

Not found

get/async-tasks/{asyncTaskId}
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Cancel asyncTask by ID

Securityapi_key
Request
path Parameters
asyncTaskId
required
integer <int32>

The ID of the asyncTask to cancel

Responses
200

Success

401

Unauthorized access

404

Not found

put/async-tasks/{asyncTaskId}/cancel
➔ Next to billingUsage