Terraform

Force execute a run, cancelling all prior runs and unlocking the workspace. Args: - runId: Run ID (required) Returns: Confirmation of force execute action.

Remove policies from a policy set. Args: - policySetId: Policy set ID (required) - policyIds: Array of policy IDs (required) Returns: Confirmation.

Get details of a specific policy. Args: - policyId: Policy ID (required) - format: Response format ('json' or 'markdown') Returns: Policy details including enforcement level and kind.

Delete a team. Args: - teamId: Team ID (required) Returns: Confirmation of deletion.

List agent pools in an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of agent pools.

Get details of an agent pool. Args: - agentPoolId: Agent pool ID (required) - format: Response format ('json' or 'markdown') Returns: Agent pool details.

Create a new agent pool. Args: - organization: Organization name (required) - name: Agent pool name (required) - organizationScoped: Available to entire organization Returns: The created agent pool.

Update an agent pool. Args: - agentPoolId: Agent pool ID (required) - name: New name - organizationScoped: Organization scoped Returns: The updated agent pool.

Delete an agent pool. Args: - agentPoolId: Agent pool ID (required) Returns: Confirmation of deletion.

List agents in an agent pool. Args: - agentPoolId: Agent pool ID (required) - format: Response format ('json' or 'markdown') Returns: List of agents with status.

Get details of a specific agent. Args: - agentId: Agent ID (required) - format: Response format ('json' or 'markdown') Returns: Agent details including status.

Delete an agent. Args: - agentId: Agent ID (required) Returns: Confirmation of deletion.

List run tasks in an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of run tasks.

Get details of a run task. Args: - taskId: Run task ID (required) - format: Response format ('json' or 'markdown') Returns: Run task details.

Create a new run task. Args: - organization: Organization name (required) - name: Run task name (required) - url: Callback URL (required) - description: Description - enabled: Enable the task - hmacKey: HMAC key for verification Returns: The created run task.

Update a run task. Args: - taskId: Run task ID (required) - name: New name - url: New callback URL - description: New description - enabled: Enable/disable Returns: The updated run task.

Delete a run task. Args: - taskId: Run task ID (required) Returns: Confirmation of deletion.

List run tasks attached to a workspace. Args: - workspaceId: Workspace ID (required) - format: Response format ('json' or 'markdown') Returns: List of workspace run tasks.

List private registry modules in an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of registry modules.

Attach a run task to a workspace. Args: - workspaceId: Workspace ID (required) - taskId: Run task ID (required) - stage: 'pre_plan', 'post_plan', 'pre_apply', or 'post_apply' (required) - enforcementLevel: 'advisory' or 'mandatory' (required) Returns: The workspace run task.

Detach a run task from a workspace. Args: - workspaceId: Workspace ID (required) - taskId: Workspace run task ID (required) Returns: Confirmation.

List organizations the authenticated user has access to. Args: - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of organizations.

Get details of a specific organization. Args: - name: Organization name (required) - format: Response format ('json' or 'markdown') Returns: Organization details including settings and permissions.

Create a new organization. Args: - name: Organization name (required) - email: Admin email (required) Returns: The created organization details.

Update an organization. Args: - name: Organization name (required) - email: New admin email - collaboratorAuthPolicy: 'password' or 'two_factor_mandatory' - costEstimationEnabled: Enable cost estimation - sessionTimeout: Session timeout in minutes - sessionRemember: Session remember in minutes Returns: The updated organization details.

Delete an organization. Args: - name: Organization name (required) Returns: Confirmation of deletion.

Get organization entitlements/features. Args: - organization: Organization name (required) Returns: List of enabled features and entitlements.

List projects in an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of projects.

Get details of a specific project. Args: - projectId: Project ID (required) - format: Response format ('json' or 'markdown') Returns: Project details.

Create a new project in an organization. Args: - organization: Organization name (required) - name: Project name (required) - description: Project description Returns: The created project details.

Update a project. Args: - projectId: Project ID (required) - name: New project name - description: New description Returns: The updated project details.

Delete a project. Args: - projectId: Project ID (required) Returns: Confirmation of deletion.

List policies in an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of policies.

Create a new policy. Args: - organization: Organization name (required) - name: Policy name (required) - description: Policy description - kind: 'sentinel' or 'opa' - enforcementLevel: 'hard-mandatory', 'soft-mandatory', 'advisory', or 'mandatory' - query: OPA query (for OPA policies) Returns: The created policy details.

Upload policy code (Sentinel or OPA). Args: - policyId: Policy ID (required) - code: Policy code (required) Returns: Confirmation of upload.

Update a policy. Args: - policyId: Policy ID (required) - description: New description - enforcementLevel: 'hard-mandatory', 'soft-mandatory', 'advisory', or 'mandatory' - query: OPA query Returns: The updated policy details.

Delete a policy. Args: - policyId: Policy ID (required) Returns: Confirmation of deletion.

List policy sets in an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of policy sets.

Get details of a policy set. Args: - policySetId: Policy set ID (required) - format: Response format ('json' or 'markdown') Returns: Policy set details.

Create a new policy set. Args: - organization: Organization name (required) - name: Policy set name (required) - description: Description - kind: 'sentinel' or 'opa' - global: Apply to all workspaces - agentEnabled: Enable for agent runs - policiesPath: Path to policies in VCS repo - vcsIdentifier: VCS repository identifier - vcsOauthTokenId: OAuth token ID for VCS Returns: The created policy set.

Update a policy set. Args: - policySetId: Policy set ID (required) - name: New name - description: New description - global: Apply globally - agentEnabled: Enable for agent runs - policiesPath: Policies path in VCS Returns: The updated policy set.

Delete a policy set. Args: - policySetId: Policy set ID (required) Returns: Confirmation of deletion.

Add policies to a policy set. Args: - policySetId: Policy set ID (required) - policyIds: Array of policy IDs (required) Returns: Confirmation.

Add workspaces to a policy set. Args: - policySetId: Policy set ID (required) - workspaceIds: Array of workspace IDs (required) Returns: Confirmation.

Remove workspaces from a policy set. Args: - policySetId: Policy set ID (required) - workspaceIds: Array of workspace IDs (required) Returns: Confirmation.

Get details of a private registry module. Args: - organization: Organization name (required) - name: Module name (required) - provider: Provider name (required) - format: Response format ('json' or 'markdown') Returns: Registry module details.

Create a new registry module (without VCS connection). Args: - organization: Organization name (required) - name: Module name (required) - provider: Provider name (required) Returns: The created registry module.

Create a registry module from a VCS repository. Args: - organization: Organization name (required) - vcsIdentifier: VCS repository identifier (required) - oauthTokenId: OAuth token ID (required) - displayIdentifier: Display identifier - tagsRegex: Regex for version tags - publishingMechanism: 'git_tag' or 'branch' - testsEnabled: Enable module tests Returns: The created registry module.

Delete a registry module (all versions). Args: - organization: Organization name (required) - name: Module name (required) - provider: Provider name (required) Returns: Confirmation of deletion.

Delete a specific version of a registry module. Args: - organization: Organization name (required) - name: Module name (required) - provider: Provider name (required) - version: Version to delete (required) Returns: Confirmation of deletion.

List runs for a workspace or organization. Args: - workspaceId: Workspace ID (optional, list runs for specific workspace) - organization: Organization name (optional, list all runs in org) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of runs with status, message, and timestamps.

Get details of a specific run. Args: - runId: Run ID (required) - format: Response format ('json' or 'markdown') Returns: Detailed run information including status, plan/apply details, and timestamps.

Get details of a specific team. Args: - teamId: Team ID (required) - format: Response format ('json' or 'markdown') Returns: Team details including permissions and organization access.

Create a new run (plan) for a workspace. Args: - workspaceId: Workspace ID (required) - message: Run message/description - isDestroy: Create a destroy plan - autoApply: Auto-apply after successful plan - planOnly: Plan only, don't allow apply - refreshOnly: Refresh state only - refresh: Refresh state before plan (default: true) - targetAddrs: Target specific resources (array of resource addresses) - replaceAddrs: Force replacement of resources (array of resource addresses) Returns: The created run details.

Apply a run that is waiting for confirmation. Args: - runId: Run ID (required) - comment: Comment for the apply action Returns: Confirmation of apply action.

Discard a run that is waiting for confirmation. Args: - runId: Run ID (required) - comment: Comment for the discard action Returns: Confirmation of discard action.

Cancel a run that is currently planning or applying. Args: - runId: Run ID (required) - comment: Comment for the cancel action - force: Force cancel (immediately terminate) Returns: Confirmation of cancel action.

Get details of a specific plan. Args: - planId: Plan ID (required) - format: Response format ('json' or 'markdown') Returns: Plan details including resource changes and status.

Get the JSON execution plan output. Args: - planId: Plan ID (required) Returns: JSON execution plan with detailed resource changes.

Get the current state version for a workspace. Args: - workspaceId: Workspace ID (required) - format: Response format ('json' or 'markdown') Returns: Current state version details including serial, terraform version, and download URLs.

List state versions for a workspace. Args: - workspaceId: Workspace ID (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of state versions.

Get details of a specific state version. Args: - stateVersionId: State version ID (required) - format: Response format ('json' or 'markdown') Returns: State version details.

List outputs from a state version. Args: - stateVersionId: State version ID (required) - format: Response format ('json' or 'markdown') Returns: List of state outputs with names, types, and values.

Rollback to a previous state version. Args: - workspaceId: Workspace ID (required) - stateVersionId: State version ID to rollback to (required) Returns: The new state version created from rollback.

List teams in an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of teams.

Create a new team in an organization. Args: - organization: Organization name (required) - name: Team name (required) - visibility: 'secret' or 'organization' - managePolicies: Can manage policies - manageWorkspaces: Can manage workspaces - manageVcsSettings: Can manage VCS settings - manageProviders: Can manage providers - manageModules: Can manage modules - manageRunTasks: Can manage run tasks - manageProjects: Can manage projects - readWorkspaces: Can read workspaces - readProjects: Can read projects Returns: The created team details.

Update a team. Args: - teamId: Team ID (required) - name: New team name - visibility: 'secret' or 'organization' - managePolicies: Can manage policies - manageWorkspaces: Can manage workspaces - manageVcsSettings: Can manage VCS settings - manageProviders: Can manage providers - manageModules: Can manage modules - manageRunTasks: Can manage run tasks - manageProjects: Can manage projects - readWorkspaces: Can read workspaces - readProjects: Can read projects Returns: The updated team details.

List variables for a workspace. Args: - workspaceId: Workspace ID (required) - format: Response format ('json' or 'markdown') Returns: List of variables with key, category, and sensitivity status.

Get details of a specific variable. Args: - workspaceId: Workspace ID (required) - variableId: Variable ID (required) - format: Response format ('json' or 'markdown') Returns: Variable details including key, value (if not sensitive), and metadata.

Create a new variable in a workspace. Args: - workspaceId: Workspace ID (required) - key: Variable key/name (required) - value: Variable value (required) - category: 'terraform' or 'env' (required) - description: Variable description - hcl: Parse value as HCL - sensitive: Mark as sensitive (value hidden after creation) Returns: The created variable details.

Update an existing variable. Args: - workspaceId: Workspace ID (required) - variableId: Variable ID (required) - key: New variable key - value: New variable value - category: 'terraform' or 'env' - description: New description - hcl: Parse as HCL - sensitive: Mark as sensitive Returns: The updated variable details.

Delete a variable from a workspace. Args: - workspaceId: Workspace ID (required) - variableId: Variable ID (required) Returns: Confirmation of deletion.

List variable sets for an organization. Args: - organization: Organization name (required) - pageNumber: Page number for pagination - pageSize: Number of items per page - format: Response format ('json' or 'markdown') Returns: Paginated list of variable sets.

Get details of a variable set. Args: - varsetId: Variable set ID (required) - format: Response format ('json' or 'markdown') Returns: Variable set details.

Create a new variable set. Args: - organization: Organization name (required) - name: Variable set name (required) - description: Description - global: Apply to all workspaces - priority: Override workspace variables Returns: The created variable set.

Update a variable set. Args: - varsetId: Variable set ID (required) - name: New name - description: New description - global: Apply globally - priority: Override workspace variables Returns: The updated variable set.

Delete a variable set. Args: - varsetId: Variable set ID (required) Returns: Confirmation of deletion.

List variables in a variable set. Args: - varsetId: Variable set ID (required) - format: Response format ('json' or 'markdown') Returns: List of variables in the set.

Add a variable to a variable set. Args: - varsetId: Variable set ID (required) - key: Variable key (required) - value: Variable value (required) - category: 'terraform' or 'env' (required) - description: Variable description - hcl: Parse as HCL - sensitive: Mark as sensitive Returns: The created variable.

Apply a variable set to workspaces. Args: - varsetId: Variable set ID (required) - workspaceIds: Array of workspace IDs (required) Returns: Confirmation of application.

Remove a variable set from workspaces. Args: - varsetId: Variable set ID (required) - workspaceIds: Array of workspace IDs (required) Returns: Confirmation of removal.

List workspaces in a Terraform Cloud organization. Returns a paginated list of workspaces with their configuration and status. Args: - organization: Organization name (required) - pageNumber: Page number for pagination (default: 1) - pageSize: Number of items per page (default: 20) - format: Response format ('json' or 'markdown') Returns: Paginated list of workspaces with ID, name, execution mode, terraform version, and lock status.

Get details of a specific workspace by ID or by organization and name. Args: - workspaceId: Workspace ID (optional if organization and name provided) - organization: Organization name (optional if workspaceId provided) - name: Workspace name (optional if workspaceId provided) - format: Response format ('json' or 'markdown') Returns: Detailed workspace information including settings, VCS configuration, and permissions.

Create a new workspace in a Terraform Cloud organization. Args: - organization: Organization name (required) - name: Workspace name (required) - description: Workspace description - autoApply: Auto-apply runs after successful plan - executionMode: 'remote', 'local', or 'agent' - terraformVersion: Terraform version to use - workingDirectory: Working directory for Terraform - projectId: Project ID to associate workspace with - vcsIdentifier: VCS repository identifier (e.g., 'owner/repo') - vcsOauthTokenId: OAuth token ID for VCS connection - vcsBranch: VCS branch to use Returns: The created workspace details.

Update an existing workspace. Args: - workspaceId: Workspace ID (required) - name: New workspace name - description: New description - autoApply: Auto-apply after plan - executionMode: 'remote', 'local', or 'agent' - terraformVersion: Terraform version - workingDirectory: Working directory Returns: The updated workspace details.

Delete a workspace from Terraform Cloud. Args: - workspaceId: Workspace ID (required) - safe: Use safe delete (fails if workspace has resources) Returns: Confirmation of deletion.

Lock a workspace to prevent runs. Args: - workspaceId: Workspace ID (required) - reason: Reason for locking Returns: The locked workspace details.

Unlock a workspace to allow runs. Args: - workspaceId: Workspace ID (required) - force: Force unlock (even if locked by another user) Returns: The unlocked workspace details.