Skip to main content
Version: 0.6.0

Configuration Versions

A Configuration Version represents a single upload of Terraform configuration to a workspace. For VCS-driven workspaces, each push creates a new configuration version with associated commit metadata via IngressAttributes.

Available Queries

QueryDescription
configurationVersions(workspaceId: ID!, filter: ConfigurationVersionFilter)List configuration versions for a workspace
configurationVersion(id: ID!)Fetch a single configuration version by ID
workspacesWithConfigurationVersionsLargerThan(includeOrgs, excludeOrgs, bytes: Int!)Find workspaces with large configuration uploads

Example

Find VCS metadata for recent configuration uploads:

query RecentConfigs($wsId: ID!) {
configurationVersions(workspaceId: $wsId) {
id
status
source
speculative
size
changedFiles
ingressAttributes {
branch
commitSha
commitMessage
senderUsername
isPullRequest
pullRequestNumber
}
}
}

Find workspaces with oversized configuration bundles:

query LargeConfigs {
workspacesWithConfigurationVersionsLargerThan(
includeOrgs: ["my-org"]
bytes: 10485760
) {
name
configurationVersions {
id
size
}
}
}

Fields

FieldTypeDescription
idID!Configuration version identifier
autoQueueRunsBoolean!Whether runs are queued automatically
errorStringError code if upload failed
errorMessageStringHuman-readable error description
provisionalBoolean!Whether this is a provisional configuration
sourceStringUpload source (e.g. tfe-api, bitbucket)
speculativeBoolean!Whether this is for a speculative plan
statusString!Upload status (pending, uploaded, errored, etc.)
statusTimestampsConfigurationVersionStatusTimestampsTimestamps for status transitions
changedFiles[String!]!List of files changed in this version
ingressAttributesIngressAttributesVCS commit metadata (see below)
sizeIntSize in bytes of the configuration bundle
downloadUrlStringURL to download the configuration archive

IngressAttributes

FieldTypeDescription
branchStringVCS branch name
commitShaStringFull commit SHA
commitMessageStringCommit message text
commitUrlStringURL to the commit in the VCS provider
isPullRequestBooleanWhether triggered by a pull request
pullRequestNumberIntPR number, if applicable
pullRequestTitleStringPR title
senderUsernameStringVCS username of the committer

Filter Fields

FieldComparison Type
idStringComparisonExp
autoQueueRunsBooleanComparisonExp
errorStringComparisonExp
errorMessageStringComparisonExp
provisionalBooleanComparisonExp
sourceStringComparisonExp
speculativeBooleanComparisonExp
statusStringComparisonExp
changedFilesStringComparisonExp
statusTimestampsConfigurationVersionStatusTimestampsFilter
  • Workspaces — Parent workspace
  • Runs — Runs created from this configuration version