{ "service": "terraform", "displayName": "Terraform", "categories": [ "Developer Tools" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Token", "placeholder": "TERRAFORM_API_TOKEN", "description": "HCP Terraform API token used with the Authorization Bearer header. Create or view user, team, or organization API tokens in HCP Terraform token settings: https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/api-tokens." } ], "homepageUrl": "https://www.hashicorp.com/products/terraform", "actions": [ { "id": "terraform.get_account_details", "service": "terraform", "name": "get_account_details", "description": "Get details for the user or service user associated with the Terraform API token.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "The input payload for getting Terraform account details." }, "outputSchema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when getting Terraform account details." } }, { "id": "terraform.get_organization", "service": "terraform", "name": "get_organization", "description": "Get details for a single HCP Terraform organization by name.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "organizationName": { "type": "string", "minLength": 1, "description": "The HCP Terraform organization name.", "pattern": "\\S" } }, "additionalProperties": false, "description": "The input payload for getting a Terraform organization." }, "outputSchema": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The included JSON:API resources returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when getting a Terraform organization." } }, { "id": "terraform.get_run", "service": "terraform", "name": "get_run", "description": "Get HCP Terraform run details by run ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "runId": { "type": "string", "minLength": 1, "description": "The HCP Terraform run ID.", "pattern": "\\S" } }, "additionalProperties": false, "description": "The input payload for getting a Terraform run." }, "outputSchema": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The included JSON:API resources returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when getting a Terraform run." } }, { "id": "terraform.get_workspace_by_id", "service": "terraform", "name": "get_workspace_by_id", "description": "Get HCP Terraform workspace details by workspace ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 1, "description": "The HCP Terraform workspace ID.", "pattern": "\\S" } }, "additionalProperties": false, "description": "The input payload for getting a Terraform workspace by ID." }, "outputSchema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The included JSON:API resources returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when getting a Terraform workspace." } }, { "id": "terraform.get_workspace_by_name", "service": "terraform", "name": "get_workspace_by_name", "description": "Get HCP Terraform workspace details by organization and workspace name.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "organizationName": { "type": "string", "minLength": 1, "description": "The HCP Terraform organization name.", "pattern": "\\S" }, "workspaceName": { "type": "string", "minLength": 1, "description": "The HCP Terraform workspace name.", "pattern": "\\S" } }, "additionalProperties": false, "description": "The input payload for getting a Terraform workspace by name." }, "outputSchema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The included JSON:API resources returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when getting a Terraform workspace." } }, { "id": "terraform.list_organizations", "service": "terraform", "name": "list_organizations", "description": "List HCP Terraform organizations visible to the authenticated token.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1, "description": "The 1-indexed page number to request." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of records to request per page." } }, "additionalProperties": false, "description": "The input payload for listing Terraform organizations." }, "outputSchema": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The organizations returned by HCP Terraform." }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] }, "meta": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API metadata object returned by HCP Terraform." }, { "type": "null" } ] }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The included JSON:API resources returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when listing Terraform organizations." } }, { "id": "terraform.list_workspace_runs", "service": "terraform", "name": "list_workspace_runs", "description": "List HCP Terraform runs for a workspace with optional filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 1, "description": "The HCP Terraform workspace ID.", "pattern": "\\S" }, "pageNumber": { "type": "integer", "minimum": 1, "description": "The 1-indexed page number to request." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of records to request per page." }, "operations": { "type": "array", "items": { "type": "string", "enum": [ "plan_only", "plan_and_apply", "save_plan", "refresh_only", "destroy", "empty_apply", "action_only" ], "description": "The run operation filter value." }, "description": "The run operations to include.", "minItems": 1 }, "statuses": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A run status.", "pattern": "\\S" }, "description": "The run statuses to include.", "minItems": 1 }, "statusGroup": { "type": "string", "enum": [ "non_final", "final", "discardable" ], "description": "The run status group filter value." }, "sources": { "type": "array", "items": { "type": "string", "enum": [ "tfe-ui", "tfe-api", "tfe-configuration-version" ], "description": "The run source filter value." }, "description": "The run sources to include.", "minItems": 1 } }, "additionalProperties": false, "required": [ "workspaceId" ], "description": "The input payload for listing Terraform workspace runs." }, "outputSchema": { "type": "object", "properties": { "runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The runs returned by HCP Terraform." }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] }, "meta": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API metadata object returned by HCP Terraform." }, { "type": "null" } ] }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The included JSON:API resources returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when listing Terraform workspace runs." } }, { "id": "terraform.list_workspaces", "service": "terraform", "name": "list_workspaces", "description": "List HCP Terraform workspaces in an organization with optional pagination.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "organizationName": { "type": "string", "minLength": 1, "description": "The HCP Terraform organization name.", "pattern": "\\S" }, "pageNumber": { "type": "integer", "minimum": 1, "description": "The 1-indexed page number to request." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of records to request per page." } }, "additionalProperties": false, "required": [ "organizationName" ], "description": "The input payload for listing Terraform workspaces." }, "outputSchema": { "type": "object", "properties": { "workspaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The workspaces returned by HCP Terraform." }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] }, "meta": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API metadata object returned by HCP Terraform." }, { "type": "null" } ] }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The JSON:API resource ID." }, "type": { "type": "string", "description": "The JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API resource attributes returned by HCP Terraform." }, "relationships": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API relationships object returned by HCP Terraform." }, { "type": "null" } ] }, "links": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The JSON:API links object returned by HCP Terraform." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A normalized JSON:API resource returned by HCP Terraform." }, "description": "The included JSON:API resources returned by HCP Terraform." } }, "additionalProperties": false, "description": "The response returned when listing Terraform workspaces." } } ] }