How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 2.0.

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

7 operations 4 paths 6 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

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

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.

Workspaces 7

Manage infrastructure workspaces

GET
/organizations/{organization_name}/workspaces
List Workspaces
ListWorkspaces 6 params → 200
POST
/organizations/{organization_name}/workspaces
Create a Workspace
CreateWorkspace 1 param body → 201
GET
/workspaces/{workspace_id}
Get a Workspace
GetWorkspace 1 param → 200
PATCH
/workspaces/{workspace_id}
Update a Workspace
UpdateWorkspace 1 param body → 200
DELETE
/workspaces/{workspace_id}
Delete a Workspace
DeleteWorkspace 1 param → 204
POST
/workspaces/{workspace_id}/actions/lock
Lock a Workspace
LockWorkspace 1 param body → 200
POST
/workspaces/{workspace_id}/actions/unlock
Unlock a Workspace
UnlockWorkspace 1 param → 200

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), PaginationMeta (1 property), WorkspaceResponse (1 property). Each schema is shown below with its type and property counts.

WorkspaceUpdateRequest
object
1 property
WorkspaceCreateRequest
object
1 property 1 required
WorkspaceResponse
object
1 property
PaginationMeta
object
1 property
Workspace
object
3 properties
WorkspaceList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terraform-workspaces-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 Variables API
Where this information came from

This is an independent, third-party profile of Terraform Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.