Docs · static mirror — the interactive version loads with JavaScript.

Terraform

Source: https://runstack.engineer/docs/toolkits/terraform

HCP Terraform workspaces, runs, state, variables, teams, policies, registry, and integrations via the Terraform Cloud API.

Tools (99):

ToolDescription
terraformListOrganizationsList HCP Terraform organizations visible to the token.
terraformGetOrganizationGet an organization with permissions, plan, and feature flags.
terraformCreateOrganizationCreate a new HCP Terraform organization with an owner email.
terraformUpdateOrganizationUpdate organization settings such as name, email, or execution mode defaults.
terraformDeleteOrganizationPermanently delete an organization and everything in it.
terraformGetOrganizationEntitlementsGet organization feature entitlements (agents, SSO, Sentinel, limits).
terraformListProjectsList projects in an organization. Projects group workspaces for access scoping.
terraformGetProjectGet a project by ID with workspace/team counts and permissions.
terraformCreateProjectCreate a project in an organization to group workspaces.
terraformUpdateProjectUpdate a project name or description.
terraformDeleteProjectDelete an empty project.
terraformListWorkspacesList workspaces in an organization with lock state and run status.
terraformGetWorkspaceGet a workspace by ID with settings, permissions, and current run.
terraformGetWorkspaceByNameGet a workspace by organization and name (human-friendly lookup).
terraformCreateWorkspaceCreate a workspace with execution settings, optionally in a project.
terraformUpdateWorkspaceUpdate workspace settings such as auto-apply, execution mode, or Terraform version.
terraformDeleteWorkspaceDelete a workspace and its runs, state, and variables.
terraformSafeDeleteWorkspaceSafely delete a workspace only if it has no managed resources.
terraformLockWorkspaceLock a workspace to prevent new runs, with an explanatory reason.
terraformUnlockWorkspaceUnlock a workspace so runs can be queued again.
terraformForceUnlockWorkspaceForce-unlock a workspace stuck locked by a crashed run.
terraformListWorkspaceRunsList runs in a workspace with status/operation filters.
terraformCreateRunQueue a plan/apply run in a workspace (or destroy/refresh-only/plan-only).
terraformGetRunGet run details: status, plan/apply state, permissions, timestamps.
terraformListOrganizationRunsList runs across an organization with status and workspace filters.
terraformApplyRunConfirm and apply a run paused for confirmation.
terraformDiscardRunDiscard a run waiting for confirmation so later runs can proceed.
terraformCancelRunGracefully cancel a planning or applying run.
terraformForceCancelRunImmediately terminate a run and unlock the workspace.
terraformForceExecuteRunExecute a pending run now, discarding blocking prior runs.
terraformGetPlanGet a plan with resource change summary and status.
terraformGetPlanJsonOutputDownload the machine-readable JSON output of a plan.
terraformGetApplyGet an apply with status, timestamps, and log readout URL.
terraformGetCostEstimateGet a run cost estimate with proposed monthly cost delta.
terraformListStateVersionsList state versions of a workspace, newest first.
terraformGetStateVersionGet a state version by ID with download URL and lineage.
terraformGetCurrentStateVersionGet the workspace's current state version.
terraformGetCurrentStateVersionOutputsGet output values of the workspace's current state.
terraformGetStateVersionOutputsGet output values of a specific state version.
terraformCreateStateVersionUpload a new state version for local-execution workspaces.
terraformCreateConfigurationVersionCreate a configuration version on a workspace (API-driven run step 1).
terraformGetConfigurationVersionGet a configuration version with source and upload status.
terraformUploadConfigurationVersionUpload a .tar.gz configuration bundle to a configuration version.
terraformListVariablesList variables for a workspace.
terraformCreateVariableCreate a Terraform or environment variable on a workspace.
terraformGetVariableGet a variable by ID (sensitive values never returned).
terraformUpdateVariableUpdate a variable key, value, description, or flags.
terraformDeleteVariableDelete a variable from a workspace.
terraformListVariableSetsList variable sets for sharing variables across workspaces.
terraformGetVariableSetGet a variable set by ID with scope and attachments.
terraformCreateVariableSetCreate a variable set scoped globally, to projects, or workspaces.
terraformUpdateVariableSetUpdate a variable set name, description, scope, or priority.
terraformDeleteVariableSetDelete a variable set and its variables.
terraformListVariableSetVarsList variables inside a variable set.
terraformAttachVariableSetWorkspacesAttach a variable set to workspaces.
terraformDetachVariableSetWorkspacesDetach a variable set from workspaces.
terraformListTeamsList teams in an organization with member counts.
terraformGetTeamGet a team by ID with permissions and member count.
terraformCreateTeamCreate a team with organization-level permissions.
terraformUpdateTeamUpdate team name, visibility, or organization permissions.
terraformDeleteTeamDelete a team (workspace access through it is revoked).
terraformListTeamTokensList team API tokens in an organization (metadata only).
terraformGetTeamTokenGet team token metadata by token ID (secret never returned).
terraformCreateTeamTokenGenerate a team API token. Secret returned once — store immediately.
terraformDeleteTeamTokenRevoke a team API token by token ID.
terraformListTeamAccessList team-to-workspace access grants.
terraformGetTeamAccessGet one team access grant by ID.
terraformCreateTeamAccessGrant a team access to a workspace (fixed or custom permissions).
terraformUpdateTeamAccessChange the permission level of a team access grant.
terraformDeleteTeamAccessRevoke a team access grant from a workspace.
terraformListPoliciesList Sentinel policies in an organization.
terraformGetPolicyGet a Sentinel policy by ID with enforcement mode.
terraformCreatePolicyCreate a Sentinel policy (code uploaded separately).
terraformUpdatePolicyUpdate a Sentinel policy name, description, or enforcement.
terraformDeletePolicyDelete a Sentinel policy.
terraformListPolicySetsList policy sets with workspace attachments.
terraformGetPolicySetGet a policy set by ID with policies and VCS settings.
terraformCreatePolicySetCreate a policy set, optionally attached to workspaces.
terraformUpdatePolicySetUpdate a policy set name, description, scope, or attachments.
terraformDeletePolicySetDelete a policy set.
terraformGetPolicyCheckGet a policy check result for a run.
terraformOverridePolicyCheckOverride soft-failed policies so the run can be applied.
terraformListRegistryModulesList private registry modules with versions.
terraformGetRegistryModuleGet a registry module with versions and VCS repo.
terraformDeleteRegistryModuleVersionDelete one version of a private registry module.
terraformListAgentPoolsList agent pools for remote execution via agents.
terraformGetAgentPoolGet an agent pool by ID.
terraformListOAuthClientsList VCS OAuth clients (GitHub, GitLab, Bitbucket, Azure DevOps).
terraformGetOAuthClientGet a VCS OAuth client by ID.
terraformListNotificationConfigsList notification configurations on a workspace.
terraformGetNotificationConfigGet a notification configuration by ID.
terraformCreateNotificationConfigCreate a workspace notification for run events.
terraformUpdateNotificationConfigUpdate a notification configuration.
terraformDeleteNotificationConfigDelete a notification configuration.
terraformVerifyNotificationConfigSend a test notification to verify delivery.
terraformListRunTriggersList run triggers that queue runs when a source workspace applies.
terraformGetRunTriggerGet a run trigger by ID.
terraformCreateRunTriggerCreate a run trigger so source applies queue runs here.
terraformDeleteRunTriggerDelete a run trigger to stop cross-workspace chaining.