Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Terraform Variables API

Manage workspace and variable sets

Terraform Variables API is one of 9 APIs that Terraform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Variables. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://app.terraform.io/api/v2.

4 operations 2 paths 5 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://app.terraform.io/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Terraform Variables API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Use organization, team, or user tokens.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Variables 4

Manage workspace and variable sets

GET
/workspaces/{workspace_id}/vars
List Workspace Variables
ListWorkspaceVariables 1 param → 200
POST
/workspaces/{workspace_id}/vars
Create a Workspace Variable
CreateWorkspaceVariable 1 param body → 201
PATCH
/workspaces/{workspace_id}/vars/{variable_id}
Update a Workspace Variable
UpdateWorkspaceVariable 2 params body → 200
DELETE
/workspaces/{workspace_id}/vars/{variable_id}
Delete a Workspace Variable
DeleteWorkspaceVariable 2 params → 204

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Variable (3 properties), VariableList (1 property), VariableUpdateRequest (1 property), VariableCreateRequest (1 property). Each schema is shown below with its type and property counts.

VariableResponse
object
1 property
Variable
object
3 properties
VariableCreateRequest
object
1 property 1 required
VariableUpdateRequest
object
1 property
VariableList
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terraform-variables-api-openapi.yml Raw ↑

Other APIs Terraform publishes across the network.

Terraform Modules API
Terraform Organizations API
Terraform Policies API
Terraform Projects API
Terraform Runs API
Terraform State Versions API
Terraform Teams API
Terraform Workspaces API