v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
policy-groups

List of policy group check results for pull requests.

get/policy-groups/{policy_group}/pull-request-policy-check-results

Path parameters

policy_groupstring required

The ID of the policy group to get pull requests for.

Query parameters

filter[environment]string

The environment ID to list policy check results for.

filter[workspace]string

The workspace ID to list policy check results for.

filter[result]string

Filter results by status.

commit_shastring

Filter results by commit SHA.

querystring

Query string

filter[terragrunt-unit]string

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

formatstring

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

page[number]string

Page number

page[size]string

Page size

sortstring[]

The comma-separated list of attributes.

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.

Response

Successfully listed preview results.