Query Component Group Tasks
Query component group policy tasks
Filters combine with logical AND across dimensions; multiple values within a field are OR. Use componentGroups (plural) as a JSON array of FLEET, MANAGEMENT, or INSTANCE.
Request
URI
POST
https://{api_host}/suite-api/api/fleet-management/password-policies/component-groups/tasks/query
COPY
Query Parameters
integer
page
Optional
Constraints:
default: 0
Page index (0-based)
integer
pageSize
Optional
Constraints:
minimum: 1
maximum: 10000
default: 1000
Page size
string
sortBy
Optional
Constraints:
default: updatedAt
Requested sort field; mapped server-side for task listing
Enumeration:
taskId,
taskType,
taskStatus,
policyId,
createdAt,
updatedAt
string
sortOrder
Optional
Constraints:
default: ASCENDING
Sort direction
Enumeration:
ASCENDING,
DESCENDING
Request Body
Optional task query filters
TasksQuery
of type(s)
application/json
Optional
"{\n \"taskIds\" : [ ],\n \"taskStatuses\" : [ ],\n \"taskTypes\" : [ ],\n \"policyIds\" : [ \"033a28ca-50be-4aa1-ada0-d7558b21c75a\" ],\n \"policyNames\" : [ \"VCF Policy1\" ],\n \"componentGroupResourceIds\" : [ \"055b39eb-70cf-4bc2-bfc2-e9779c32d88a\" ],\n \"componentGroupResourceFqdns\" : [ ],\n \"componentGroups\" : [ \"INSTANCE\" ]\n}"
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
Responses
200
Paged policy tasks
Returns
PasswordPolicyTasks
of type(s)
application/json
"{\n \"pageInfo\" : {\n \"totalCount\" : 1,\n \"page\" : 0,\n \"pageSize\" : 50\n },\n \"tasks\" : [ {\n \"taskId\" : \"077c4afc-81df-5cd3-ccd3-f0880d43999b\",\n \"taskType\" : \"POLICY_APPLY\",\n \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n \"targetComponentGroups\" : {\n \"componentGroupResourceIds\" : [ \"055b39eb-70cf-4bc2-bfc2-e9779c32d88a\" ],\n \"componentGroups\" : [ \"INSTANCE\" ]\n },\n \"taskStatus\" : \"IN_PROGRESS\",\n \"createdAt\" : 1741630060000,\n \"updatedAt\" : 1741716460000,\n \"policyName\" : \"VCF Policy1\",\n \"targetComponentGroupsState\" : [ {\n \"componentGroupResourceId\" : \"055b39eb-70cf-4bc2-bfc2-e9779c32d88a\",\n \"componentGroupResourceFqdn\" : \"sddc-manager.example.com\",\n \"componentGroupResourceName\" : \"SDDC Manager\",\n \"componentGroup\" : \"INSTANCE\",\n \"complianceUpdatedAt\" : 1741716460000,\n \"componentGroupComplianceStatus\" : \"IN_PROGRESS\",\n \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n \"policyName\" : \"VCF Policy1\"\n }, {\n \"componentGroupResourceId\" : \"066c49fc-81df-4bd2-cdc3-f0880d43990a\",\n \"componentGroupResourceFqdn\" : \"vcenter.example.com\",\n \"componentGroupResourceName\" : \"vCenter Server\",\n \"componentGroup\" : \"INSTANCE\",\n \"complianceUpdatedAt\" : 1741700000000,\n \"componentGroupComplianceStatus\" : \"COMPLIANT\",\n \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n \"policyName\" : \"VCF Policy1\"\n } ],\n \"componentGroupsComplianceStatistics\" : [ {\n \"status\" : \"IN_PROGRESS\",\n \"count\" : 1\n }, {\n \"status\" : \"COMPLIANT\",\n \"count\" : 1\n } ]\n } ]\n}"
array of
object
links
Optional
Collection of links
object
pageInfo
Optional
Represents page information for a paged result
array of
object
tasks
Optional
Paged policy task details matching the query
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/fleet-management/password-policies/component-groups/tasks/query
On This Page
Fleet Password Policy Management Operations
POST
Create Password Policy
PUT
Update Password Policy
POST
Export Compliance
POST
Query Components
POST
Query Component Groups
POST
Submit Policy Task
POST
Query Component Group Tasks
GET
Get Component Group Task
POST
Export Password Policies
POST
Query Password Policies
DELETE
Delete Password Policy
GET
Get Password Policy