Query Components

Query Components
Query components within password policy managed component groups

Returns a flat paged list of component details. 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/components/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: complianceUpdatedAt

Requested sort field; mapped server-side for drift listing

Enumeration: componentResourceId, componentResourceFqdn, componentResourceName, componentResourceType, componentComplianceStatus, complianceUpdatedAt, statusUpdatedAt
string
sortOrder
Optional
Constraints: default: ASCENDING

Sort direction

Enumeration: ASCENDING, DESCENDING
Request Body

Optional component query filters

ComponentQuery of type(s) application/json
Optional 
"{\n  \"componentGroups\" : [ \"FLEET\" ],\n  \"componentGroupResourceIds\" : [ ],\n  \"componentGroupResourceFqdns\" : [ ],\n  \"componentResourceIds\" : [ ],\n  \"componentResourceFqdns\" : [ ],\n  \"componentResourceTypes\" : [ \"SDDC_MANAGER\" ],\n  \"componentComplianceStatuses\" : [ ],\n  \"componentGroupComplianceStatuses\" : [ \"COMPLIANT\" ],\n  \"policyIds\" : [ \"033a28ca-50be-4aa1-ada0-d7558b21c75a\" ],\n  \"policyNames\" : [ \"VCF Policy1\" ]\n}"
array of string
componentComplianceStatuses
Optional
Constraints: minItems: 0 maxItems: 100

Compliance statuses of the components within the component group resource

Enumeration: COMPLIANT, NON_COMPLIANT, NOT_ELIGIBLE, IN_PROGRESS, PENDING, FAILED, NO_POLICY, UNKNOWN
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

VCF adapter instance FQDNs (INSTANCE scope). Union with componentGroups and resource IDs.

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

VCF adapter instance resource IDs (INSTANCE scope). Union with componentGroups and FQDNs.

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

JSON componentGroups (plural): array of FLEET, MANAGEMENT, INSTANCE (union with instance id/FQDN lists).

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

Resource FQDNs of the components within the component group resource

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

Resource IDs of the components within the component group resource

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

Resource types of the components within the component group resource

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

Restrict to components whose policy id matches any listed id (OR within the list). Combined with other non-empty filter dimensions using logical AND.

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

Restrict to components whose policy display name matches any listed name (OR within the list, case-insensitive trim). Combined with other non-empty filter dimensions using logical AND.

Authentication
This operation uses the following authentication methods.
Responses
200

Paged resources

Returns PasswordPolicyComponents of type(s) application/json 
"{\n  \"pageInfo\" : {\n    \"totalCount\" : 0,\n    \"page\" : 0,\n    \"pageSize\" : 50,\n    \"sortBy\" : \"complianceUpdatedAt\",\n    \"sortOrder\" : \"ASCENDING\"\n  },\n  \"results\" : [ ]\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 components matching the query within the policy-managed component group context


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/components/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