---
title: "Get a Configuration Version"
method: GET
path: "/configuration-versions/{configuration_version}"
tags: ["configuration-versions"]
---

# Get a Configuration Version

`GET /configuration-versions/{configuration_version}`

## Request

- Base URL: `https://example.scalr.io/api/iacp/v3`
- URL: `https://example.scalr.io/api/iacp/v3/configuration-versions/{configuration_version}`
- Auth: HTTP bearer

Show details of a specific Configuration Version.

## Path parameters

- `configuration_version` string, required

## Query parameters

- `include` string[]

## Response `200`

The request was successful.

- ConfigurationVersionDocument: JSON:API Document. see: https://jsonapi.org/format/#document-structure
  - `data` ConfigurationVersion: A Configuration Version describes the version of a Terraform configuration files. Each run is associated with a configuration version. It provides details of the source of the configuration files, the upload status, and the relationships to VCS and the workspace.
    - `attributes` object
      - `auto-queue-runs` boolean: Indicates if a run should automatically be queued when the configuration has been uploaded.
      - `created-at` string, date-time: Date/Time the configuration version was created.
      - `error-message` string, nullable: This field contains the error description, when this configuration version's status is `errored`.
      - `inputs` union[]: The input variables definitions. Example: ```js [ { "description": "The name of the CloudSQL database.", "name": "cloudsql_database", "type": "string" }, {"...": ""..."} ] ```
        - union
          - RegistryInputOptional
            - `default` union, required
              - …
            - `description` string, nullable
            - `name` string, required
            - `sensitive` boolean
            - `type` string, nullable
          - RegistryInputRequired
            - `description` string, nullable
            - `name` string, required
            - `sensitive` boolean
            - `type` string, nullable
      - `is-dry` boolean: Indicates the configuration version can only be used to perform dry runs that comprise the plan, cost estimation (if enabled) and policy checks. With this set to `true` the configuration cannot be used for an apply and never requires confirmation.
      - `size` integer, nullable: A blob size in bytes.
      - `source` string: The origin for the configuration version.
      - `status` 'errored' | 'pending' | 'uploaded': The Configuration version's current status. * `pending` - waiting for the configuration files to upload. * `uploaded` - upload successful. At this point if the `auto-queue-runs: true` the new run should be `queued`. * `errored` - uploaded files post processing failed. Attribute `error-message` contains the details.
      - `status-timestamps` object: Date/Time of transition to each status that has occurred.
    - `id` string
    - `links` object
      - `self` string
      - `upload` string, nullable: URL for terraform configuration templates upload, that could be used to `PUT` a tar.gz archive of a local workspace directory. Available only in the create `configuration-versions` response.
    - `relationships` object
      - `vcs-revision` object: When configuration version was uploaded from a VCS, this relation points to the Git commit information
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'vcs-revisions' | '', required
      - `workspace` object: The workspace the configuration version belongs to.
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'workspaces' | '', required
    - `type` 'configuration-versions', required
  - `included` object[]
  - `meta` object

## Other responses

- `404`: Configuration version not found or user unauthorized to perform action.
- `4XX`: Client error.
- `5XX`: Server error.

## Changes

- **2026-11-03** `d3e1dc85657a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/scalr/apis/scalr-iacp-api/changes/configuration-versions/:configuration_version/get.md)

---

[API](https://skmtc.dev/scalr/apis/scalr-iacp-api.md) - [All operations](https://skmtc.dev/scalr/apis/scalr-iacp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scalr/apis/scalr-iacp-api/revisions/d3e1dc85657a?raw)
