Query Component Groups
Query component group resources where the password policy is applied
Filters are combined using logical OR; returns a deduplicated union of all matches. 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/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: statusUpdatedAt
Requested sort field; server may normalize for instance resources
Enumeration:
componentGroupResourceId,
componentGroupResourceFqdn,
componentGroupResourceName,
componentGroup,
policyId,
policyName,
statusUpdatedAt,
componentGroupComplianceStatus
string
sortOrder
Optional
Constraints:
default: ASCENDING
Sort direction
Enumeration:
ASCENDING,
DESCENDING
Request Body
Optional component group query filters
ComponentGroupQuery
of type(s)
application/json
Optional
"{\n \"componentGroupResourceIds\" : [ ],\n \"componentGroupResourceFqdns\" : [ ],\n \"componentGroupResourceNames\" : [ ],\n \"policyIds\" : [ \"033a28ca-50be-4aa1-ada0-d7558b21c75a\" ],\n \"policyNames\" : [ ],\n \"componentGroups\" : [ \"INSTANCE\" ],\n \"componentGroupComplianceStatuses\" : [ \"COMPLIANT\", \"NOT_ELIGIBLE\", \"NO_POLICY\" ]\n}"
array of
string
componentGroupComplianceStatuses
Optional
Constraints:
minItems: 0
maxItems: 100
Compliance statuses of the component group
Enumeration:
COMPLIANT,
NON_COMPLIANT,
NOT_ELIGIBLE,
IN_PROGRESS,
PENDING,
FAILED,
NO_POLICY,
UNKNOWN
array of
string
componentGroupResourceFqdns
Optional
Constraints:
minItems: 0
maxItems: 100
Component Group resource FQDNs (example item: sddc-manager.cloud.example.com)
array of
string
componentGroupResourceIds
Optional
Constraints:
minItems: 0
maxItems: 100
Component group resource IDs
array of
string
componentGroupResourceNames
Optional
Constraints:
minItems: 0
maxItems: 100
Component Group resource names
array of
string
componentGroups
Optional
Constraints:
minItems: 0
maxItems: 100
JSON componentGroups (plural): array of FLEET, MANAGEMENT, INSTANCE.
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
Responses
200
Paged resources
Returns
PasswordPolicyComponentGroups
of type(s)
application/json
"{\n \"pageInfo\" : {\n \"totalCount\" : 1,\n \"page\" : 0,\n \"pageSize\" : 50,\n \"sortBy\" : \"statusUpdatedAt\",\n \"sortOrder\" : \"ASCENDING\"\n },\n \"results\" : [ {\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\" : \"COMPLIANT\",\n \"policyId\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n \"policyName\" : \"Fleet Example Policy\"\n } ]\n}"
array of
object
links
Optional
Collection of links
object
pageInfo
Optional
Represents page information for a paged result
array of
object
results
Optional
Paged component group resources 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/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