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 Teams API

Manage teams and memberships

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

Tagged areas include Teams. 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 DELETE2 GET1 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 Teams 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, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Teams 4

Manage teams and memberships

GET
/organizations/{organization_name}/teams
List Teams
ListTeams 3 params → 200
POST
/organizations/{organization_name}/teams
Create a Team
CreateTeam 1 param body → 201
GET
/teams/{team_id}
Get a Team
GetTeam 1 param → 200
DELETE
/teams/{team_id}
Delete a Team
DeleteTeam 1 param → 204

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Team (3 properties), TeamList (2 properties), TeamCreateRequest (1 property), PaginationMeta (1 property). Each schema is shown below with its type and property counts.

TeamResponse
object
1 property
PaginationMeta
object
1 property
Team
object
3 properties
TeamCreateRequest
object
1 property 1 required
TeamList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terraform-teams-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 Variables API
Terraform Workspaces API