--- updatedAt: 2026-05-28T08:16:45.000Z agentTools: projectIndex: https://docs.scalr.io/llms.txt --- # List of policy group check results for pull requests. # OpenAPI definition ```json { "components": { "schemas": { "PolicyCheckResult": { "description": "Represents a terraform policy check result.", "properties": { "attributes": { "properties": { "messages": { "description": "The messages returned by the policy check.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the policy.", "maxLength": 100, "type": "string" }, "pull-request-number": { "description": "The number of the pull request that triggered the policy check.", "nullable": true, "type": "string" }, "pull-request-title": { "description": "The title of the pull request that triggered the policy check.", "maxLength": 512, "nullable": true, "type": "string" }, "result": { "description": "The result of the policy check.", "enum": [ "passed", "hard_failed", "soft_failed", "advisory_failed" ], "type": "string" }, "unit-path": { "description": "The terragrunt unit path relative to the working directory.", "nullable": true, "type": "string" } }, "type": "object" }, "id": { "readOnly": true, "type": "string" }, "links": { "additionalProperties": { "type": "string" }, "type": "object" }, "relationships": { "properties": { "environment": { "description": "The environment associated with this policy check result.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "environments", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "policy-check": { "description": "The policy check this result belongs to.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "policy-checks", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "run": { "description": "The run associated with this policy check result.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "runs", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "workspace": { "description": "The workspace associated with this policy check result.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "workspaces", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "enum": [ "policy-check-results" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "PolicyCheckResultListingDocument": { "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure", "properties": { "data": { "items": { "$ref": "#/components/schemas/PolicyCheckResult" }, "type": "array" }, "included": { "items": { "type": "object" }, "readOnly": true, "type": "array" }, "links": { "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" }, "meta": { "readOnly": true, "type": "object" } }, "type": "object" } }, "securitySchemes": { "API-Key": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "Scalr IACP API", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "title": "Scalr IACP API", "version": "unversioned" }, "openapi": "3.0.0", "paths": { "/policy-groups/{policy_group}/pull-request-policy-check-results": { "get": { "operationId": "list_pull_request_policy_check_results", "parameters": [ { "description": "The ID of the policy group to get pull requests for.", "in": "path", "name": "policy_group", "required": true, "schema": { "type": "string" } }, { "description": "The environment ID to list policy check results for.", "in": "query", "name": "filter[environment]", "required": false, "schema": { "type": "string" } }, { "description": "The workspace ID to list policy check results for.", "in": "query", "name": "filter[workspace]", "required": false, "schema": { "type": "string" } }, { "description": "Filter results by status.", "in": "query", "name": "filter[result]", "required": false, "schema": { "type": "string" } }, { "description": "Filter results by commit SHA.", "in": "query", "name": "commit_sha", "required": false, "schema": { "type": "string" } }, { "description": "Query string", "in": "query", "name": "query", "required": false, "schema": { "type": "string" } }, { "description": "The unit path filter. Example: `filter[unit_path]=vpc`", "in": "query", "name": "filter[terragrunt-unit]", "required": false, "schema": { "type": "string" } }, { "description": "Format of the response. It can be 'json' or 'csv'.", "in": "query", "name": "format", "required": false, "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "string" } }, { "description": "Page size", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "string" } }, { "description": "The comma-separated list of attributes.", "in": "query", "name": "sort", "required": false, "schema": { "items": { "enum": [ "name", "pull-request-number", "result" ], "type": "string" }, "type": "array" } }, { "description": "The comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "environment", "workspace" ], "type": "string" }, "type": "array" } }, { "description": "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.", "explode": true, "in": "query", "name": "fields", "required": false, "schema": { "properties": { "environments": { "description": "The comma-separated list of fields to return in response for Environment resource.", "type": "string" }, "policy-check-results": { "description": "The comma-separated list of fields to return in response for PolicyCheckResult resource.", "type": "string" }, "workspaces": { "description": "The comma-separated list of fields to return in response for Workspace resource.", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PolicyCheckResultListingDocument" } }, "text/csv": { "schema": { "format": "csv", "type": "string" } } }, "description": "Successfully listed preview results." }, "404": { "description": "Policy Group not found or user unauthorized to perform action." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "List of policy group check results for pull requests.", "tags": [ "policy-groups" ], "x-mcp-tool": true, "x-resource": "PolicyGroup", "x-service": "tf-api" } } }, "security": [ { "API-Key": [] } ], "servers": [ { "url": "https://{Domain}/api/iacp/v3", "variables": { "Domain": { "default": "example.scalr.io", "description": "Domain where Scalr is hosted" } } } ] } ``` # Sibling pages * [List Policy Groups](https://docs.scalr.io/scalr/reference/list_policy_groups.md) * [Create a Policy Group](https://docs.scalr.io/scalr/reference/create_policy_group.md) * [Delete a Policy Group](https://docs.scalr.io/scalr/reference/delete_policy_group.md) * [Get a Policy Group](https://docs.scalr.io/scalr/reference/get_policy_group.md) * [Update a Policy Group](https://docs.scalr.io/scalr/reference/update_policy_group.md) * [Resync a Policy Group](https://docs.scalr.io/scalr/reference/resync_policy_group.md)