Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Workspaces

List Run Resources

Lists Resources Affected by a Run

post/workspaces/{workspaceId}/runs/{runId}/resources/search

Query parameters

pageinteger
pageSizeinteger

Request body

projectionstring[]

Fields to include in the response

searchValuestring

Value to search for across searchable fields

mode'table' | 'graph' | 'summary' | 'costPolicy' required

The mode to display the resources in

Example request

{
  "filters": {
    "action": [
      "create"
    ],
    "taskType": [
      "post-plan"
    ],
    "resourceId": [
      "aws_s3_bucket.logs"
    ],
    "providerName": [
      "aws"
    ],
    "$or": {
      "action": [
        "create"
      ],
      "taskType": [
        "post-plan"
      ],
      "resourceId": [
        "aws_s3_bucket.logs"
      ],
      "providerName": [
        "aws"
      ]
    }
  }
}

Response

Run resources retrieved successfully

OR

Example response

{
  "resources": [
    {
      "id": "507f1f77bcf86cd799439011",
      "accountId": "507f1f77bcf86cd799439011",
      "taskId": "507f1f77bcf86cd799439013",
      "name": "aws_instance.example",
      "type": "aws_instance",
      "mode": "managed",
      "action": "create",
      "taskType": "post-plan",
      "dataType": "terraform",
      "providerName": "aws",
      "providerType": "aws",
      "providerVersion": "4.0.0"
    }
  ]
}