ComponentQuery

ComponentQuery

Retrieves a flat, paged list of component-only fields (PolicyComponent): resource identity, component compliance, constraints snapshot, etc. Policy and component-group scope filters still apply on the request body, but policy id/name and enclosing group metadata are not returned on each component row.

The body may include componentGroups, componentGroupResourceIds, componentGroupResourceFqdns, policyIds, policyNames, componentResourceIds, componentResourceFqdns, componentResourceTypes, componentComplianceStatuses, and componentGroupComplianceStatuses.

Filtering Behavior: A component row is kept only if it satisfies every non-empty filter dimension (logical AND). Within a single list field, multiple values are OR (match any). If nothing matches, results is empty.

componentGroups selects which group kinds to query (FLEET, MANAGEMENT, INSTANCE). componentGroupResourceIds and componentGroupResourceFqdns resolve INSTANCE adapter instances and are unioned with componentGroups. If the body is omitted or carries no scope or component filters, components for every scope (FLEET, MANAGEMENT, and all INSTANCE rows present in compliance summary data) are included before URL pagination is applied to the merged list.

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

JSON Example

{
    "componentComplianceStatuses": [
        "string"
    ],
    "componentGroupComplianceStatuses": [
        "string"
    ],
    "componentGroupResourceFqdns": [
        "string"
    ],
    "componentGroupResourceIds": [
        "string"
    ],
    "componentGroups": [
        "string"
    ],
    "componentResourceFqdns": [
        "string"
    ],
    "componentResourceIds": [
        "string"
    ],
    "componentResourceTypes": [
        "string"
    ],
    "policyIds": [
        "string"
    ],
    "policyNames": [
        "string"
    ]
}

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.

Parameter To

Query Components