List Policy Group Check results

get

https://{Domain}/api/iacp/v3/policy-group-checks/{policy_group_check}/policy-check-results

List policy check results for a specific policy group check.

Required permission: policy_groups:read

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

policy_group_check

string

required

Query Params

query

string

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

format

string

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

include

array of strings

The comma-separated list of relationship paths.

include

fields

object

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

sort

array of strings

The comma-separated list of attributes.

sort

Headers

string

enum

Defaults to application/vnd.api+json

Generated from available response content types

Allowed:

Responses

403

User unauthorized to perform this action.

404

Policy group check not found.

4XX

Client error.

5XX

Server error.

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

text/csv

200Success.