Skip to content

Main Navigation Docs Blog Releases Playground Terramate Cloud

Appearance

Sidebar Navigation

👋 Introduction

About Terramate

How it works

Why Terramate

Product Roadmap

Discord Community

🚀 Getting Started

Install Terramate CLI

Start with Terraform

Start with OpenTofu

Start with Terragrunt

Start using the Cloud

💻 Terramate CLI

Stacks

Create Stacks

Nesting Stacks

Configure Stacks

Clone Stacks

Manage Stacks

Delete Stacks

Orchestration

Run Commands

Workflows

Change Detection

Integration: Git

Integration: Terraform

Integration: Terragrunt

Integration: OpenTofu

Parallel Execution

Order of Execution

Tag Filter

Outputs Sharing

Environment Variables

Disable Safeguards

CI/CD

GitHub Actions

Preview Workflow

Deployment Workflow

Drift Check Workflow

GitLab CI

Preview Workflow

Deployment Workflow

Drift Check Workflow

Bitbucket Pipelines

Preview Workflow

Deployment Workflow

Drift Check Workflow

Atlantis 🚧

Digger 🚧

Azure DevOps 🚧

AWS CodeBuild 🚧

BuildKite 🚧

CircleCI 🚧

Jenkins 🚧

Teamcity 🚧

Code Generation

Generate ad-hoc HCL

Generate HCL

Generate Files

☁️ Terramate Cloud

Dashboard

Resources

Resource Details

Alerts

Stacks Inventory

Stack Status

View Stacks

View Stack Details

Synchronize Stacks

Pull Request Previews

Synchronize in Automation

Synchronize via Scripts

Deployments

Get Deployment Notification

Synchronize in Automation

Synchronize from CLI

Synchronize via Scripts

Drift Management

Get Drift Notifications

Synchronize in Automation

Synchronize from CLI

Synchronize via Scripts

Policies

Integrations

Slack

GitHub

Conflict Detection

GitLab 🚧

Profile

Account Linking

Organization

General Settings

VCS OpenID Setup

Slack Webhook

User Management

API Keys

API Reference

System

GET check if the service is alive.

GET Check if the service is well.

GET Returns information for the Terramate CLI regarding supported versions.

Users

GET Returns a User from their user_id in the JWT.

POST Create the current User.

PATCH Update current logged in user

POST Link any platform account to this user.

DELETE Unlink some platform accounts to this user.

POST Link a user with their Gitlab account using their JWT ID token.

GET Generate a connection URL to BitBucket OAuth2 Code flow.

GET Landing page to end BitBucket User linking

Drifts

POST Create drift run for a stack.

GET Get Drift Details

POST Summarize Drift Plan

GET Get all drifts of a stack

Organizations

POST Create an organization

GET Get organization SSO data from a organization.

GET Get organization details.

PATCH Update an organization

GET Get organization memberships of the current user

Organization Members

GET Get all memberships of an organization.

POST Create a member in an organization.

DELETE Delete a membership of an invited user

PATCH Update users membership options of an organization

Deployments

GET Get all deployments from an organization.

GET Get deployments activity from an organization.

GET Get all deployments of a stack.

GET Get a batch of logs for a deployment.

POST Send a batch of logs for a deployment.

POST Summarize deployment logs

POST Batch start a new deployment for each stack in a list of stacks

PATCH Batch update stack status for a deployment.

GET Get details from a workflow deployment group

POST Summarize Workflow Deployment Group

GET Get stack deployments from a workflow deployment group.

GET Get stack deployments.

GET Get stack deployment details.

POST Summarize Stack Deployment Plan

GET Get DORA report with total values.

GET Get DORA report within a time range.

GET Get DORA report grouped by rating bucket.

Dashboard Data

GET Return historic deployment data for the last X days of deployments.

GET Get dashboard data for an organization

GET Get dashboard data for alerts widget

GET Get dashboard data for alerts period widget

GET Get dashboard data for review requests widget

GET Get dashboard data for review requests period widget

GET Get dashboard data for deployments period widget

Stacks

GET Get stacks of an organization

GET Get stack details from an organization

PATCH Update specific attributes for the stack `stack_id`

GET Get last SARIF report from a drift check run for a stack.

HEAD Check if there is a SARIF report available from a drift check run for a stack.

Reports

GET Get last SARIF report from a drift check run for a stack.

HEAD Check if there is a SARIF report available from a drift check run for a stack.

GET Get DORA report with total values.

GET Get DORA report within a time range.

GET Get DORA report grouped by rating bucket.

GET Get DORA report with total values.

GET Get DORA report within a time range.

GET Get DORA report grouped by rating bucket.

Review Requests

GET List the review requests from an organization

GET Get the details of a review request.

GET Get DORA report with total values.

GET Get DORA report within a time range.

GET Get DORA report grouped by rating bucket.

Filters

GET Get available filters for a provided entity.

GET Get available filters for review requests.

GET Get available filters for workflow deployment groups.

GitHub App

GET Generate a connection URL to GitHub App.

GET Returns the status of the github app installation for this org.

GET Landing page after installing GitHub App.

Gitlab

GET Get token status for Gitlab webhooks

POST Generate a new token for Gitlab webhooks

DELETE Delete token for Gitlab webhooks

Slack App

GET Generate a connection URL to Slack App.

GET Landing page to end Slack App installation.

GET Returns the status of the slack app installation for this org.

Previews

POST Start a new preview for each stack part of a review request

POST Summarize a preview

PATCH Update specific attributes for the stack preview associated with `stack_preview_id`

GET Get a batch of logs for a stack preview

POST Persist log lines for the provided `stack_preview_id`

POST Summarize stack preview logs

POST Summarize stack preview plan for changes.

Alerts

GET Select a set of alerts from an organization.

GET Get an alert from an organization.

PATCH Update an alert from an organization.

GET Get affected stacks for an alert.

GET Get an alert timeline from an alert.

Resources

GET Select a set of resources from an organization.

GET Get a specific resource.

GET Get a list of deployment change sets for the resource.

GET Get the latest drift change set for a resource

GET Get a list of preview change sets for open reviews related to the resource.

Org API Keys

GET List API keys belonging to an organization

POST Create an API key for an organization

DELETE Delete an API key

License Keys

GET List licenses for terramate-pro belonging to an organization

POST Create an license key for terramate-pro for an organization

GET Get details from a license for terramate-pro.

DELETE Revoke a license for terramate-pro.

Store

GET lookup an output by its composite key.

POST Store outputs for a Terraform stack.

GET Get an output by ID.

DELETE Delete an output by ID.

PUT Update the output value

🔒 Security

Security and Data Processing

Locations and Data Residency

👷 How-to Guides

Manage Environments

Using Workspaces

Reference Architectures

AWS

Microsoft Azure

Google Cloud 🚧

Terragrunt

Code Generation

Basic DRY Code Generation

Terraform Backend and Provider Generation

Dynamic Provider Generation

⚙️ Reference

Variable Namespaces

Metadata

Blocks

terramate

stack

generate_hcl

generate_file

globals

lets

map

script

assert

import

Variables

Globals

Lets

Metadata

Map

Functions

Terramate

tm_ternary

tm_hcl_expression

tm_version_match

Numeric Functions

tm_abs

tm_ceil

tm_floor

tm_log

tm_max

tm_min

tm_parseint

tm_pow

tm_signum

String Functions

tm_chomp

tm_format

tm_formatlist

tm_indent

tm_join

tm_lower

tm_regex

tm_regexall

tm_replace

tm_split

tm_strcontains

tm_startswith

tm_endswith

tm_strrev

tm_substr

tm_title

tm_trim

tm_trimprefix

tm_trimsuffix

tm_trimspace

tm_upper

Collection Functions

tm_alltrue

tm_anytrue

tm_chunklist

tm_coalesce

tm_coalescelist

tm_compact

tm_concat

tm_contains

tm_distinct

tm_element

tm_flatten

tm_index

tm_keys

tm_length

tm_lookup

tm_matchkeys

tm_merge

tm_one

tm_range

tm_reverse

tm_setintersection

tm_setproduct

tm_setsubtract

tm_setunion

tm_slice

tm_sort

tm_sum

tm_transpose

tm_values

tm_zipmap

Encoding Functions

tm_base64decode

tm_base64encode

tm_base64gzip

tm_csvdecode

tm_jsondecode

tm_jsonencode

tm_tomlencode

tm_tomldecode

tm_hclencode

tm_hcldecode

tm_textdecodebase64

tm_textencodebase64

tm_urlencode

tm_yamldecode

tm_yamlencode

Filesystem Functions

tm_abspath

tm_dirname

tm_pathexpand

tm_basename

tm_file

tm_fileexists

tm_fileset

tm_filebase64

tm_templatefile

Date and Time Functions

tm_formatdate

tm_timeadd

tm_timecmp

tm_timestamp

Hash and Crypto Functions

tm_base64sha256

tm_base64sha512

tm_bcrypt

tm_filebase64sha256

tm_filebase64sha512

tm_filemd5

tm_filesha1

tm_filesha256

tm_filesha512

tm_md5

tm_rsadecrypt

tm_sha1

tm_sha256

tm_sha512

tm_uuid

tm_uuidv5

IP Network Functions

tm_cidrhost

tm_cidrnetmask

tm_cidrsubnet

tm_cidrsubnets

tm_cidrcontains

Type Conversion Functions

tm_can

tm_tobool

tm_tolist

tm_tomap

tm_tonumber

tm_toset

tm_tostring

tm_try

CLI Commands

Stacks and Orchestration

create

list

run

trigger

debug show runtime-env

experimental clone

Terramate Scripts

script run

script info

script list

script tree

Code Generation

fmt

generate

debug show metadata

debug show globals

debug show generate-origins

Terramate Cloud

cloud login

cloud info

cloud drift show

Misc

install-completions

version

Experimental

experimental eval

experimental partial-eval

experimental get-config-value

experimental run-graph

experimental vendor download

Upgrade Check

CLI Authentication

Configuration Reference

Telemetry

👨🏽‍💻 Dev Tooling

VSCode Extension

VIM Plugin

Language Server

Check if the service is well.

GET

/healthcheck

Check if the service is well.

Responses

Service is healthy.

GET

/healthcheck

Playground

Samples

Powered by VitePress OpenAPI

Pager

Previous page GET check if the service is alive.

Next page GET Returns information for the Terramate CLI regarding supported versions.