Terraform Cloud icon

Terraform Cloud

Interact with the Terraform Cloud API

Actions16

Run → Create Plan Run

AI-generated

Summary

Create a plan-only run in a specified Terraform Cloud workspace, optionally attaching a descriptive message to the run.

Inputs

  • Workspace ID (required) — The ID of the workspace in which to create the plan-only run.
  • Message — An optional message to attach to the plan run, providing context or description.

Output shape

a single JSON object representing the created run details as returned by the Terraform Cloud API

Returns the full API response for the newly created plan-only run under the workspace. The operation requires the workspace ID and optionally accepts a message. Errors during creation will be surfaced by the node.

Examples

Example 1: Create a plan-only run with a custom message

Set Workspace ID to the target workspace's ID, and provide a message describing the purpose of the plan run.

Links

Discussion