v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB

policy-group-checks

List Policy Group Check results

List policy check results for a specific policy group check.

Required permission: policy_groups:read

get/policy-group-checks/{policy_group_check}/policy-check-results

Path parameters

policy_group_checkstring required

Query parameters

querystring

The query string to search for.

filter[policy]string

The policy name filter. Example: filter[policy]=workspace_name

filter[date]string

The date range filter. Example: filter[date]=between:2022-01-01T00:00:00Z,2022-02-01T00:00:00Z

filter[result]string

The result of the policy check filter. Example: filter[result]=hard-failed

filter[environment]string

The environment ID to list policy check results for. Example: filter[environment]=env-123456

filter[workspace]string

The workspace ID to list policy check results for. Example: filter[workspace]=ws-123456

filter[terragrunt-unit]string

The unit path filter. Example: filter[unit_path]=vpc

formatstring

Format of the response. It can be 'json' or 'csv'.

includestring[]

The comma-separated list of relationship paths.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

policy-check-resultsstring

The comma-separated list of fields to return in response for PolicyCheckResult resource.

workspacesstring

The comma-separated list of fields to return in response for Workspace resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

page[number]string

Page number

page[size]string

Page size

sortstring[]

The comma-separated list of attributes.

Response

Success.