AI agents for HCP Terraform

List organizations

Lists the organizations this token can reach, as data: each with id (its name, used by the other actions) and attributes (name, email, created-at).

List workspaces

Lists an organization's workspaces, as data: each with id (ws-…, used by the run actions) and attributes.

Get a workspace by name

Reads one workspace by its organization and name: data.id (ws-…) and data.attributes.

List a workspace's runs

Lists a workspace's runs, newest first, as data: each with id (run-…) and attributes.

Get a run and its plan

Reads one run: data.attributes.status (planning, planned, applying, applied, errored, discarded …), message, has-changes, actions.is-confirmable (can be applied now) and status-timestamps.

Get a workspace's outputs

Reads the outputs of a workspace's current state, as data: each with attributes.name, value, type and sensitive (sensitive values come back as null).

Start a plan

Queues a run on a workspace with its latest configuration and waits for approval.

Apply a planned runDeletes data

Confirms a run waiting at planned (or policy_checked) so HCP Terraform applies its plan and changes real infrastructure, including destroying the resources the plan removes.

Discard a planned run

Throws away a run waiting for confirmation, so its plan is never applied and the workspace moves on to the next run.

Cancel a running runDeletes data

Interrupts a run that is planning or applying, like Ctrl+C in the Terraform CLI.