Config Versions¶
-
class
terrasnek.config_versions.TFCConfigVersions(instance_url, org_name, headers, well_known_paths, verify, log_level)¶ -
-
create(workspace_id, payload)¶ POST /workspaces/:workspace_id/configuration-versions
-
list(workspace_id, page=None, page_size=None)¶ GET /workspaces/:workspace_id/configuration-versionsConfig Versions List API Doc Reference
- Query Parameter(s) (details):
page(Optional)page_size(Optional)
-
list_all(workspace_id)¶ 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 array of objects.
-
required_entitlements()¶ Terraform Cloud Entitlements required for endpoint to work.
-
show(config_version_id)¶ GET /configuration-versions/:configuration-id
-
upload(path_to_tarball, upload_url)¶ PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID>
-
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.
-