Skip to content
One platform. From customer conversation to completed work.Take a closer look
All connections
Developer Tools · CONNECTION

HCP Terraform + NodeHub

Manage HCP Terraform (Terraform Cloud) workspaces and runs: create and update workspaces, queue, apply, discard and cancel runs, and read state versions.

Explore 17 workflow actions for HCP Terraform, including account permissions and operation limits.

8 read actions9 write actions
WORKFLOW ACTIONS

What you can configure.

Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.

Add a run comment

Write

Adds a comment to a run.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

A repeated request may repeat the external action. Review the previous result before retrying a write.

Apply a run

Write

Applies a run whose plan is waiting for confirmation.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Operation limits

  • Changes real infrastructure. 202 means the apply was queued; read the run for its outcome.

A repeated request may repeat the external action. Review the previous result before retrying a write.

Cancel a run

Write

Interrupts a run that is planning or applying (like Ctrl+C).

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a run

Write

Queues a run in a workspace: a plan left for manual apply, a plan-only (speculative) run, a refresh-only or destroy run, or one that applies automatically.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Operation limits

  • Needs a user or team token (organization tokens cannot create runs). An auto-apply or destroy run changes real infrastructure. Run-specific variables are not offered.

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a workspace

Write

Creates a workspace in an organization, optionally connected to a VCS repository and placed in a project.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

A repeated request may repeat the external action. Review the previous result before retrying a write.

Discard a run

Write

Discards a run that is waiting for confirmation or a policy override.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

A repeated request may repeat the external action. Review the previous result before retrying a write.

Force delete a workspace

Write

Deletes a workspace even if it still manages resources; Terraform then stops tracking them.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Operation limits

  • Needs force-delete permission. The infrastructure keeps running untracked; use Safe delete when unsure.

A repeated request may repeat the external action. Review the previous result before retrying a write.

Get a run

Read

Reads a run's status, timestamps, actions allowed and related plan and apply.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Get a workspace

Read

Reads a workspace, including its settings, VCS repository and run performance figures.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Get the current state version

Read

Reads the workspace's current state version: serial, status, Terraform version, resources, modules and providers (no download links).

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

List a workspace's runs

Read

Lists a workspace's runs, filtered by operation, status, status group, source, year, user or commit.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Pagination: page. Check the result for additional pages; a single action may not return every record.

List GitHub App installations

Read

Lists the GitHub App installations the token's user can use for VCS workspaces.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

List projects

Read

Lists an organization's projects, by name search or exact names.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Pagination: page. Check the result for additional pages; a single action may not return every record.

List run comments

Read

Lists the comments on a run.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

List workspaces

Read

Lists an organization's workspaces, with name, tag, project and run-status filters.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

Pagination: page. Check the result for additional pages; a single action may not return every record.

Safe delete a workspace

Write

Deletes a workspace only if it manages no resources (409 otherwise).

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a workspace

Write

Changes a workspace's name and settings, its VCS repository, or moves it to another project.

Permissions and limits

Account permissions

  • An HCP Terraform user or team API token with access to the organization's workspaces and runs

A repeated request may repeat the external action. Review the previous result before retrying a write.

SETUP

Start with a controlled test.

01Connect the intended account

Use the account and permissions required for your process. Review the connection check before configuring a workflow action.

02Review inputs and access

Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.

03Confirm the result

Inspect step outputs and confirm the result in HCP Terraform. A saved workflow is not a completed provider action.

Follow the workflow quickstart
EXPLORE YOUR STACK

More in Developer Tools.

HCP Terraform integration | NodeHub