Run Triggers

class terrasnek.run_triggers.TFCRunTriggers(instance_url, org_name, headers, well_known_paths, verify, log_level)

Run Triggers API Docs

create(workspace_id, payload)

POST /workspaces/:workspace_id/run-triggers

Run Triggers Create API Doc Reference

Create Sample Payload

destroy(run_trigger_id)

DELETE /run-triggers/:run_trigger_id

Run Triggers Destroy API Doc Reference

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

GET /workspaces/:workspace_id/run-triggers

Run Triggers List API Doc Reference

Query Parameter(s) Details

list_all(workspace_id, filters=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 trigger for a workspace.

Returns an object with two arrays of objects.

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(run_trigger_id)

GET /run-triggers/:run_trigger_id

Run Triggers 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.