Skip to main content
Terraform
Terraform
118 actions · 1 auth method
PreviewInfrastructure

​
Authentication

API Token

Generate an API token from your Terraform Cloud or Terraform Enterprise account settings.Guides: Connector Profile, Link Account
Actions
118 actions
Action
Description
Get Account Details
Retrieve details about the authenticated user’s account.
List Configuration Versions
List configuration versions for a workspace.
Get Configuration Version
Retrieve details about a specific configuration version.
Get Configuration Version Commit Info
Retrieve commit information for a configuration version.
Create Configuration Version
Create a new configuration version for uploading configuration files.
Archive Configuration Version
Archive a configuration version.
Download Configuration Version
Download configuration files for a configuration version.
Download Run Configuration Version
Download configuration files for a run.
Soft Delete Configuration Version
Mark a configuration version for garbage collection (Enterprise only).
Restore Configuration Version
Restore a configuration version marked for garbage collection (Enterprise only).
Permanently Delete Configuration Version
Permanently delete a configuration version (Enterprise only).
Get Cost Estimate
Retrieve a cost estimate for a run.
List Notification Configurations
List notification configurations for a workspace.
Get Notification Configuration
Retrieve details about a notification configuration.
Create Notification Configuration
Create a notification configuration for a workspace.
Update Notification Configuration
Update a notification configuration.
Delete Notification Configuration
Delete a notification configuration.
List Organizations
List all organizations the user has access to.
Get Organization
Retrieve details about a specific organization.
Create Organization
Create a new organization.
Update Organization
Update an existing organization’s settings.
Delete Organization
Delete an organization and all its resources.
Get Organization Entitlements
Retrieve the entitlement set for an organization.
List Organization Memberships
List all memberships for an organization.
List Own Memberships
List the current user’s organization memberships.
Get Organization Membership
Retrieve details about a specific organization membership.
Invite User To Organization
Invite a user to join an organization.
Remove User From Organization
Remove a user from an organization.
Get Plan
Retrieve details about a specific plan.
Get Plan JSON Output
Retrieve the JSON execution plan by plan ID.
Get Run Plan JSON Output
Retrieve the JSON execution plan by run ID.
Get Apply
Retrieve details about a specific apply.
Get Errored State
Recover state from a failed apply.
Create Plan Export
Export a plan for external use.
Get Plan Export
Retrieve details about a plan export.
Download Plan Export
Get download URL for an exported plan.
Delete Plan Export
Delete an exported plan.
List Projects
List all projects in an organization.
Get Project
Retrieve details about a specific project.
Create Project
Create a new project in an organization.
Update Project
Update an existing project’s configuration.
Delete Project
Delete an empty project.
Move Workspaces To Project
Move workspaces into a project.
List Project Tag Bindings
List tags bound to a project.
Update Project Tag Bindings
Add or update tag bindings on a project.
List Runs In Workspace
List all runs for a specific workspace.
List Runs In Organization
List all runs across an organization.
Get Run
Retrieve details about a specific run.
Create Run
Create a new run in a workspace.
Apply Run
Apply a planned run.
Discard Run
Discard a run that has not been applied.
Cancel Run
Cancel a run that is currently planning or applying.
Force Cancel Run
Forcefully cancel a run after normal cancel has been initiated.
Force Execute Run
Force execute a pending run.
List Policy Checks
List policy checks for a run.
Get Policy Check
Retrieve details about a specific policy check.
Override Policy Check
Override a soft-mandatory policy check.
List Run Comments
List comments on a run.
Create Run Comment
Add a comment to a run.
List Run Triggers
List all run triggers for a workspace.
Get Run Trigger
Retrieve details about a specific run trigger.
Create Run Trigger
Create a run trigger to connect workspaces.
Delete Run Trigger
Delete a run trigger.
List State Versions
List state versions for a workspace.
Get State Version
Retrieve details about a specific state version.
Get Current State Version
Retrieve the current state version for a workspace.
Create State Version
Create a new state version for a workspace.
Rollback State Version
Rollback to a previous state version.
Soft Delete State Version
Mark a state version for garbage collection (Enterprise only).
Restore State Version
Restore a state version marked for garbage collection (Enterprise only).
Permanently Delete State Version
Permanently delete a state version (Enterprise only).
List State Version Outputs
List outputs for a state version.
Get State Version Output
Retrieve a specific state version output.
Get Current State Version Outputs
List outputs from the current state version of a workspace.
List Teams
List all teams in an organization.
Get Team
Retrieve details about a specific team.
Create Team
Create a new team in an organization.
Update Team
Update an existing team’s configuration.
Delete Team
Delete a team from an organization.
Add Members To Team
Add organization members to a team by organization membership ID.
Delete Members From Team
Delete organization members from a team by organization membership ID.
Get User
Retrieve details about a specific user.
List Workspace Variables
List all variables in a workspace.
Create Workspace Variable
Create a new variable in a workspace.
Update Workspace Variable
Update an existing workspace variable.
Delete Workspace Variable
Delete a variable from a workspace.
List Variable Sets
List all variable sets for an organization.
List Project Variable Sets
List all variable sets for a project.
List Workspace Variable Sets
List all variable sets for a workspace.
Get Variable Set
Retrieve details about a specific variable set.
Create Variable Set
Create a new variable set in an organization.
Update Variable Set
Update an existing variable set.
Delete Variable Set
Delete a variable set.
List Variable Set Variables
List all variables in a variable set.
Add Variable To Set
Add a variable to a variable set.
Update Variable In Set
Update a variable in a variable set.
Delete Variable From Set
Delete a variable from a variable set.
Apply Variable Set To Workspaces
Apply a variable set to one or more workspaces.
Remove Variable Set From Workspaces
Remove a variable set from one or more workspaces.
Apply Variable Set To Projects
Apply a variable set to one or more projects.
Remove Variable Set From Projects
Remove a variable set from one or more projects.
List Workspaces
List all workspaces in an organization.
Get Workspace
Retrieve details about a specific workspace.
Get Workspace By ID
Retrieve details about a workspace using its ID.
Create Workspace
Create a new workspace in an organization.
Update Workspace
Update an existing workspace’s configuration.
Delete Workspace
Delete a workspace and all its data.
Safe Delete Workspace
Safely delete a workspace only if it has no managed resources.
Lock Workspace
Lock a workspace to prevent new runs.
Unlock Workspace
Unlock a workspace to allow new runs.
Force Unlock Workspace
Force unlock a workspace locked by another user.
Get Workspace Tags
List tags attached to a workspace.
Add Workspace Tags
Add tags to a workspace.
Delete Workspace Tags
Remove tags from a workspace.
Get Remote State Consumers
List workspaces that can access this workspace’s state.
Add Remote State Consumers
Add workspaces that can access this workspace’s state.
Delete Remote State Consumers
Remove workspaces from accessing this workspace’s state.
Assign SSH Key
Assign an SSH key to a workspace.

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/terraform/filled/png

Connector Profile

Terraform - API Token
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/terraform/filled/png

Link Account

Terraform - API Token
4

Use Actions

Invoke actions using one of the methods below: