Terraform Workspaces API
Manage infrastructure workspaces
Terraform Workspaces API is one of 9 APIs that Terraform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 7 operations across 4 paths, and defines 6 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Terraform Workspaces 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 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Manage infrastructure workspaces
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Workspace (3 properties), WorkspaceList (2 properties), WorkspaceUpdateRequest (1 property), WorkspaceResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Terraform 8
Other APIs Terraform publishes across the network.