Projects

class terrasnek.projects.TFCProjects(instance_url, org_name, headers, well_known_paths, verify, log_level)

Projects API Docs

create(payload)

POST /organizations/:organization_name/projects

Projects Create API Doc Reference

Create Sample Payload

destroy(project_id)

DELETE /projects/:project_id

Projects Destroy API Doc Reference

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

GET /organizations/:organization_name/projects

Projects List API Doc Reference

Query Parameter(s) Details

list_all(filters=None, query=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 run for a workspace.

Returns an object with two arrays of objects.

move_workspaces_into_project(project_id, payload)

POST /projects/:project_id/relationships/workspaces

Projects Move Workspaces Into Project API Doc Reference

Move Workspaces Into Project Sample Payload

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(project_id)

GET /projects/:project_id

Projects 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.

update(project_id, payload)

PATCH /projects/:project_id

Projects Update API Doc Reference

Update Sample Payload