Appearance
Terraform Cloud
Manage infrastructure as code with Terraform Cloud workspaces, runs, and state.
| Detail | Value |
|---|---|
| Category | DevOps |
| Base URL | https://app.terraform.io/api/v2 |
| Authentication | Bearer Token |
| Endpoints | 8 |
| Connector key | terraform-cloud |
Using Terraform Cloud in a workflow
- Go to Connections and click New Connection.
- Pick Terraform Cloud from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown — the full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
GET /organizations | List organizations |
GET /organizations/{organization_name}/workspaces | List workspaces |
POST /organizations/{organization_name}/workspaces | Create a workspace |
GET /workspaces/{workspace_id} | Get workspace details |
POST /runs | Create a run |
GET /runs/{run_id} | Get run details |
POST /runs/{run_id}/actions/apply | Apply a run |
GET /workspaces/{workspace_id}/current-state-version | Get current state |
Each endpoint is documented in full below. Use the outline on the right to jump to one.
GET /organizations
List organizations
| Detail | Value |
|---|---|
| Operation ID | devops.listOrganizations |
| Method | GET |
| Path | /organizations |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.listOrganizations. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.
GET /organizations/{organization_name}/workspaces
List workspaces
| Detail | Value |
|---|---|
| Operation ID | devops.listWorkspaces |
| Method | GET |
| Path | /organizations/{organization_name}/workspaces |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.listWorkspaces. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.
POST /organizations/{organization_name}/workspaces
Create a workspace
| Detail | Value |
|---|---|
| Operation ID | devops.createWorkspace |
| Method | POST |
| Path | /organizations/{organization_name}/workspaces |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.createWorkspace. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.
GET /workspaces/{workspace_id}
Get workspace details
| Detail | Value |
|---|---|
| Operation ID | devops.getWorkspace |
| Method | GET |
| Path | /workspaces/{workspace_id} |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.getWorkspace. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.
POST /runs
Create a run
| Detail | Value |
|---|---|
| Operation ID | devops.createRun |
| Method | POST |
| Path | /runs |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.createRun. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.
GET /runs/{run_id}
Get run details
| Detail | Value |
|---|---|
| Operation ID | devops.getRun |
| Method | GET |
| Path | /runs/{run_id} |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.getRun. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.
POST /runs/{run_id}/actions/apply
Apply a run
| Detail | Value |
|---|---|
| Operation ID | devops.applyRun |
| Method | POST |
| Path | /runs/{run_id}/actions/apply |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.applyRun. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.
GET /workspaces/{workspace_id}/current-state-version
Get current state
| Detail | Value |
|---|---|
| Operation ID | devops.getCurrentStateVersion |
| Method | GET |
| Path | /workspaces/{workspace_id}/current-state-version |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Terraform Cloud connection from the Connection dropdown.
- In the Operation dropdown, select
devops.getCurrentStateVersion. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Terraform Cloud API reference.