← Tools Reference

Terraform

Terraform integration (Developer Tools). Imported from open-connector.

API key8 toolshttps://app.terraform.io/api/v2
GET
terraform_get_account_details
Get details for the user or service user associated with the Terraform API token.

/account/details

GET
terraform_list_organizations
List HCP Terraform organizations visible to the authenticated token.

/organizations

2 parameters
ParamTypeRequiredDescription
pageNumberintegeroptionalThe 1-indexed page number to request.
pageSizeintegeroptionalThe number of records to request per page.
GET
terraform_get_organization
Get details for a single HCP Terraform organization by name.

/organizations/{organizationName}

1 parameter
ParamTypeRequiredDescription
organizationNamestringrequiredThe HCP Terraform organization name.
GET
terraform_list_workspaces
List HCP Terraform workspaces in an organization with optional pagination.

/organizations/{organizationName}/workspaces

3 parameters
ParamTypeRequiredDescription
organizationNamestringrequiredThe HCP Terraform organization name.
pageNumberintegeroptionalThe 1-indexed page number to request.
pageSizeintegeroptionalThe number of records to request per page.
GET
terraform_get_workspace_by_id
Get HCP Terraform workspace details by workspace ID.

/workspaces/{workspaceId}

1 parameter
ParamTypeRequiredDescription
workspaceIdstringrequiredThe HCP Terraform workspace ID.
GET
terraform_get_workspace_by_name
Get HCP Terraform workspace details by organization and workspace name.

/organizations/{organizationName}/workspaces/{workspaceName}

2 parameters
ParamTypeRequiredDescription
organizationNamestringrequiredThe HCP Terraform organization name.
workspaceNamestringrequiredThe HCP Terraform workspace name.
GET
terraform_list_workspace_runs
List HCP Terraform runs for a workspace with optional filters.

/workspaces/{workspaceId}/runs

7 parameters
ParamTypeRequiredDescription
workspaceIdstringrequiredThe HCP Terraform workspace ID.
pageNumberintegeroptionalThe 1-indexed page number to request.
pageSizeintegeroptionalThe number of records to request per page.
operationsarrayoptionalThe run operations to include.
statusesarrayoptionalThe run statuses to include.
statusGroupstringoptionalThe run status group filter value.
sourcesarrayoptionalThe run sources to include.
GET
terraform_get_run
Get HCP Terraform run details by run ID.

/runs/{runId}

1 parameter
ParamTypeRequiredDescription
runIdstringrequiredThe HCP Terraform run ID.