> ## Documentation Index
> Fetch the complete documentation index at: https://www.ravion.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List terraform execution summaries

> List terraform execution summaries with filters.

Returns terraform execution summaries. Must provide either pipelineId, pipelineRunId, or stackId.
Only runs that reached Terraform report generation have summaries. To query every execution
attempt, including failures without summaries, list pipeline runs instead.

- pipelineId: Returns available summaries for runs of the pipeline
- pipelineRunId: Returns summaries for a specific run
- stackId: Returns available summaries for runs of a stack



## OpenAPI

````yaml https://api.ravion.com/openapi.yaml get /terraform-execution-summaries
openapi: 3.0.0
info:
  title: Ravion
  version: 0.0.0
servers:
  - url: https://api.ravion.com
security:
  - BearerAuth: []
tags:
  - name: Projects
  - name: Environments
  - name: Pipelines
  - name: PipelineRuns
  - name: TerraformResources
  - name: TerraformExecutionSummaries
  - name: PipelineStepExecutions
  - name: AwsCloudWatch
  - name: PipelineVersions
  - name: Organizations
  - name: Stacks
  - name: StackWorkspaces
  - name: Auth
  - name: OAuth
  - name: User
  - name: Health
  - name: Memberships
  - name: ServiceAccounts
  - name: AwsDefaultNetworks
  - name: AwsAccounts
  - name: ApiKeys
  - name: ExecutionEnvironments
  - name: ModuleDefinitions
  - name: ModuleVersions
  - name: ModuleInstances
  - name: DefaultValueDefinitions
  - name: DefaultValues
  - name: CodeSources
  - name: Github
  - name: Gitlab
  - name: Git
  - name: Values
  - name: Deployments
  - name: DeploymentResources
  - name: InfrastructureEvents
  - name: WebSocket
  - name: Describe
paths:
  /terraform-execution-summaries:
    get:
      tags:
        - TerraformExecutionSummaries
      summary: List terraform execution summaries
      description: >-
        List terraform execution summaries with filters.


        Returns terraform execution summaries. Must provide either pipelineId,
        pipelineRunId, or stackId.

        Only runs that reached Terraform report generation have summaries. To
        query every execution

        attempt, including failures without summaries, list pipeline runs
        instead.


        - pipelineId: Returns available summaries for runs of the pipeline

        - pipelineRunId: Returns summaries for a specific run

        - stackId: Returns available summaries for runs of a stack
      operationId: TerraformExecutionSummaryList
      parameters:
        - description: >-
            Pipeline ID to filter by - returns available summaries for runs of
            this pipeline
          in: query
          name: pipelineId
          schema:
            nullable: true
            type: string
        - description: Pipeline run ID to filter by
          in: query
          name: pipelineRunId
          schema:
            nullable: true
            type: string
        - description: Step execution ID to filter by (optional)
          in: query
          name: stepExecutionId
          schema:
            nullable: true
            type: string
        - description: >-
            Stack ID to filter by - returns available summaries for runs of this
            stack
          in: query
          name: stackId
          schema:
            nullable: true
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/TerraformExecutionSummaries'
                    type: array
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
                required:
                  - data
                  - meta
                type: object
          description: The request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: The request is invalid or malformed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You are not authenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You do not have permission to access this resource.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Client error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Server error
components:
  schemas:
    TerraformExecutionSummaries:
      additionalProperties: false
      description: >-
        Terraform execution summary model representing aggregated counts for a
        step execution that

        reached Terraform report generation. Executions that fail before report
        generation do not

        produce a summary.
      properties:
        addCount:
          description: Number of resources to be created
          format: int32
          type: integer
        applyable:
          description: Whether Terraform/OpenTofu reports the saved plan should be applied
          type: boolean
        changeCount:
          description: Number of resources to be updated
          format: int32
          type: integer
        createdAt:
          allOf:
            - $ref: '#/components/schemas/UtcDateTime'
          readOnly: true
        destroyCount:
          description: Number of resources to be destroyed
          format: int32
          type: integer
        id:
          readOnly: true
          type: string
        importCount:
          description: Number of resources to be imported into state
          format: int32
          type: integer
        organizationId:
          readOnly: true
          type: string
        output:
          additionalProperties: {}
          description: Non-sensitive terraform output values from this execution
          type: object
        pipelineId:
          description: The pipeline ID this summary belongs to (derived from pipeline run)
          readOnly: true
          type: string
        pipelineRunId:
          description: The pipeline run ID this summary belongs to
          readOnly: true
          type: string
        planFilename:
          description: Optional plan filename this summary is associated with
          type: string
        readCount:
          description: Number of data sources to be read
          format: int32
          type: integer
        replaceCount:
          description: Number of resources to be replaced (destroy + create)
          format: int32
          type: integer
        runType:
          allOf:
            - $ref: '#/components/schemas/TerraformRunType'
          description: The type of terraform run (PLAN, APPLY, DESTROY)
        stackId:
          description: The stack ID this summary belongs to
          readOnly: true
          type: string
        stepExecutionId:
          description: The step execution ID this summary belongs to (unique)
          type: string
        unchangedCount:
          description: Number of resources with no changes
          format: int32
          type: integer
        updatedAt:
          allOf:
            - $ref: '#/components/schemas/UtcDateTime'
          readOnly: true
      required:
        - id
        - createdAt
        - updatedAt
        - organizationId
        - stepExecutionId
        - pipelineRunId
        - pipelineId
        - addCount
        - changeCount
        - destroyCount
        - replaceCount
        - importCount
        - readCount
        - unchangedCount
        - runType
      type: object
    PaginationMeta:
      additionalProperties: false
      properties:
        limit:
          format: int32
          type: integer
        nextCursor:
          type: string
        totalCount:
          format: int32
          type: integer
      required:
        - limit
      type: object
    Errors.UserFacingErrorData:
      additionalProperties: false
      description: |-
        User-facing error presentation data.
        This is what the API returns to the frontend after formatting ErrorData
        using CEL templates from the error registry.

        Used for both:
        - Error fields on domain models (e.g., PipelineRun.error)
        - API error response bodies (HTTP 4xx/5xx responses)
      properties:
        action:
          allOf:
            - $ref: '#/components/schemas/Errors.Action'
          description: Optional action to help resolve the error
        code:
          description: Full error code, e.g., "Ravion:Pipeline:NOT_FOUND"
          type: string
        description:
          description: Additional description with more details
          type: string
        details:
          description: Structured details rendered as user-facing sections.
          items:
            $ref: '#/components/schemas/Errors.UserFacingErrorDetailSection'
          type: array
        isInternal:
          description: >-
            Indicates whether this error is internal (only set when
            ShowInternal=true).

            This allows SUPERADMINs to identify internal errors while viewing
            full details.
          type: boolean
        message:
          description: Main error message (required)
          type: string
        metadata:
          additionalProperties: {}
          description: >-
            Error params/metadata. Stripped for internal errors unless
            superadmin.
          type: object
        requestId:
          description: Request ID for correlating errors with server logs.
          type: string
      required:
        - code
        - message
      type: object
    UtcDateTime:
      description: UTC RFC3339 timestamp with a required Z suffix
      format: date-time
      pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z$
      type: string
      x-go-type: apitypes.UTCDateTime
      x-go-type-import:
        name: apitypes
        path: ravion/api-go/pkg/apitypes
    TerraformRunType:
      enum:
        - PLAN
        - APPLY
        - DESTROY
      type: string
    Errors.Action:
      additionalProperties: false
      description: Action to help user resolve the error
      properties:
        label:
          description: Button/link label text
          type: string
        url:
          description: URL to navigate to for resolution
          type: string
      required:
        - label
        - url
      type: object
    Errors.UserFacingErrorDetailSection:
      additionalProperties: false
      description: Structured user-facing error detail section.
      properties:
        items:
          description: List of detail values for this section.
          items:
            type: string
          type: array
        object:
          additionalProperties: {}
          description: Structured detail payload for object rendering.
          type: object
        render:
          description: Rendering hint for clients. Valid values are list or object.
          type: string
        title:
          description: Detail section title shown in the UI.
          type: string
      required:
        - title
        - render
      type: object
  securitySchemes:
    BearerAuth:
      scheme: Bearer
      type: http

````