State Versions

class terrasnek.state_versions.TFCStateVersions(instance_url, org_name, headers, well_known_paths, verify, log_level)

State Versions API Docs

create(workspace_id, payload)

POST /workspaces/:workspace_id/state-versions

State Versions Create API Doc Reference

Create Sample Payload

get_current(workspace_id)

GET /workspaces/:workspace_id/current-state-version

State Versions Get Current API Doc Reference

list(filters, page=None, page_size=None)

GET /state-versions

State Versions List API Doc Reference

Query Parameter(s) (details):

• filter[workspace][name] (Required)
• filter[organization][name] (Required)
• page (Optional)
• page_size (Optional)

Example filter(s):

filters = [
    {
        "keys": ["workspace", "name"],
        "value": "foo"
    },
    {
        "keys": ["organization", "name"],
        "value": "bar"
    }
]

list_all(filters)

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 state version for a workspace.

Returns an array of objects.

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(state_version_id)

GET /state-versions/:state_version_id

State Versions Show 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.