Config Versions¶

class terrasnek.config_versions.TFCConfigVersions(instance_url, org_name, headers, well_known_paths, verify, log_level)¶

Config Versions API Docs

archive_version(config_version_id)¶

POST /configuration-versions/:configuration_version_id/actions/archive

Config Versions Archive Version API Doc Reference

create(workspace_id, payload)¶

POST /workspaces/:workspace_id/configuration-versions

Config Versions Create API Doc Reference

Create Sample Payload

download_version_files(config_version_id=None, run_id=None)¶

GET /configuration-versions/:configuration_version_id/download GET /runs/:run_id/configuration-version/download

Config Versions Download Files API Doc Reference

list(workspace_id, page=None, page_size=None, include=None)¶

GET /workspaces/:workspace_id/configuration-versions

Config Versions List API Doc Reference

Query Parameter(s) Details

list_all(workspace_id, include=None)¶

This function does not correlate to an endpoint in the TFC API Docs specifically, but rather is a helper function to wrap the list endpoint, which enumerates out every page so users do not have to implement the paging logic every time they just want to list every config version in a workspace.

Returns an object with two arrays of objects.

required_entitlements()¶: Terraform Cloud Entitlements required for endpoint to work.

show(config_version_id, include=None)¶

GET /configuration-versions/:configuration-id

Config Versions Show API Doc Reference

show_config_version_commit_info(config_version_id, include=None)¶

GET /configuration-versions/:configuration-id/ingress-attributes GET /configuration-versions/:configuration-id?include=ingress-attributes

Config Versions Show Commit Information API Doc Reference

terraform_cloud_only()¶: Return True if this endpoint is only for Terraform Cloud, else False.

terraform_enterprise_only()¶: Return True if this endpoint is only for Terraform Enterprise, else False.

upload(path_to_tarball, upload_url)¶

PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID>

Config Versions Upload API Doc Reference

upload_from_string(template_string, upload_url)¶

PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID>

Config Versions Upload API Doc Reference

Set configuration version from string, rather than pre-existing tarball.

NOTE: this does not map to typical API usage, but for ease of use in some use cases, it’s fine.