TasksQuery

TasksQuery
TasksQuery

Retrieves a list of policy tasks based on the provided query parameters. The body may include taskIds, taskStatuses, taskTypes, policyIds, policyNames, componentGroups, componentGroupResourceIds, and componentGroupResourceFqdns.

Filtering Behavior: Every returned task must satisfy all non-empty filter dimensions (logical AND). Within each list field, multiple values are OR (match any). componentGroupResourceIds and componentGroupResourceFqdns are resolved together to instance resource IDs before matching the task's persisted target. If no task matches every active filter, the result list is empty.

Request JSON: Use the property componentGroups (plural) as a JSON array of strings (FLEET, MANAGEMENT, INSTANCE).

JSON Example
{
    "componentGroupResourceFqdns": [
        "string"
    ],
    "componentGroupResourceIds": [
        "string"
    ],
    "componentGroups": [
        "string"
    ],
    "policyIds": [
        "string"
    ],
    "policyNames": [
        "string"
    ],
    "taskIds": [
        "string"
    ],
    "taskStatuses": [
        "string"
    ],
    "taskTypes": [
        "string"
    ]
}
array of string
componentGroupResourceFqdns
Optional
Constraints: minItems: 0 maxItems: 100

Component group resource FQDNs (resolved to instance IDs; AND with other non-empty dimensions)

array of string
componentGroupResourceIds
Optional
Constraints: minItems: 0 maxItems: 100

Component group resource IDs (AND with other non-empty filter dimensions; OR within this list)

array of string
componentGroups
Optional
Constraints: minItems: 0 maxItems: 100

JSON componentGroups (plural): array of FLEET, MANAGEMENT, INSTANCE. Matches tasks whose persisted target overlaps (AND with other non-empty filters; OR within this list).

Enumeration: FLEET, MANAGEMENT, INSTANCE, UNKNOWN
array of string
policyIds
Optional
Constraints: minItems: 0 maxItems: 100

Policy IDs

array of string
policyNames
Optional
Constraints: minItems: 0 maxItems: 100

Policy names (each name max length 255)

array of string
taskIds
Optional
Constraints: minItems: 0 maxItems: 100

Task IDs

array of string
taskStatuses
Optional
Constraints: minItems: 0 maxItems: 100

Task statuses

Enumeration: IN_PROGRESS, COMPLETED, FAILED, UNKNOWN
array of string
taskTypes
Optional
Constraints: minItems: 0 maxItems: 100

Task types

Enumeration: POLICY_APPLY, POLICY_DETACH, POLICY_RETRY, POLICY_REMEDIATE, COMPLIANCE_RUN, UNKNOWN