Admin Workspaces

class terrasnek.admin_workspaces.TFCAdminWorkspaces(instance_url, org_name, headers, well_known_paths, verify, log_level)

Admin Workspaces API Docs

The Admin API is exclusive to Terraform Enterprise, and can only be used by the admins and operators who install and maintain their organization’s Terraform Enterprise instance.

The Workspaces Admin API contains endpoints to help site administrators manage workspaces.

destroy(ws_id)

DELETE /admin/workspaces/:id

Admin Workspaces Destroy API Doc Reference

list(filters=None, page=None, page_size=None, sort=None, search=None, include=None)

GET /api/v2/admin/workspaces

Admin Workspaces List API Doc Reference

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(ws_id)

GET /api/v2/admin/workspaces/:id

Admin Workspaces 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.