Workspaces

class terrasnek.workspaces.TFCWorkspaces(instance_url, org_name, headers, well_known_paths, verify, log_level)

Workspaces API Docs

assign_ssh_key(workspace_id, payload)

PATCH /workspaces/:workspace_id/relationships/ssh-key

Workspaces Assign SSH Key API Doc Reference

Assign Sample Payload

create(payload)

POST /organizations/:organization_name/workspaces

Workspaces Create API Doc Reference

Create Sample Payload

destroy(workspace_id=None, workspace_name=None)

DELETE /organizations/:organization_name/workspaces/:name DELETE /workspaces/:workspace_id

Workspaces Destroy API Doc Reference

force_unlock(workspace_id)

POST /workspaces/:workspace_id/actions/force-unlock

Workspaces Force Unlock API Doc Reference

list(page=None, page_size=None)

GET /organizations/:organization_name/workspaces

Workspaces List API Doc Reference

Query Parameter(s) (details):
  • page (Optional)
  • page_size (Optional)
lock(workspace_id, payload)

POST /workspaces/:workspace_id/actions/lock

Workspaces Lock API Doc Reference

Lock Sample Payload

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(workspace_name=None, workspace_id=None)

GET /organizations/:organization_name/workspaces/:name GET /workspaces/:workspace_id

Workspaces Show API Doc Reference

unassign_ssh_key(workspace_id, payload)

PATCH /workspaces/:workspace_id/relationships/ssh-key

Workspaces Unassign SSH Key API Doc Reference

Unassign Sample Payload

unlock(workspace_id)

POST /workspaces/:workspace_id/actions/unlock

Workspaces Unlock API Doc Reference

update(payload, workspace_name=None, workspace_id=None)

PATCH /organizations/:organization_name/workspaces/:name PATCH /workspaces/:workspace_id

Workspaces Update API Doc Reference

Update Sample Payload