Manage ngrok Programmatically With Terraform and API Client Libraries

API client libraries

Open-source API client libraries are published to make working with the ngrok API feel native and fluent in your favorite programming language. Library repositories are published in the ngrok github organization.

Language	Installation	Documentation	Repository
Go	`go get github.com/ngrok/ngrok-api-go/v4`	Documentation	GitHub
.NET	`dotnet add package NgrokApi`	Documentation	GitHub
Ruby	`gem install ngrok-api`	Documentation	GitHub
Python	`pip install ngrok-api`	Documentation	GitHub
Java (unstable)	See the README for installing with Maven	Documentation	GitHub
Scala (unstable)	See the README for installing with Maven	Documentation	GitHub

For more details, see the API Client Libraries documentation.

Terraform provider

When you use ngrok resources as part of production infrastructure, it is an industry best practice to define them using an infrastructure-as-code tool like Terraform. An official Terraform provider is published that consumes the ngrok API to manage your resources in this way. Consult the documentation for the ngrok Terraform provider on Hashicorp’s Terraform Registry.

example.tf

# Configure the ngrok provider
provider "ngrok" {
  api_key = "{API_KEY}"
}

# Provision an ngrok domain
resource "ngrok_reserved_domain" "my_domain" {
  name   = "my-domain.example.com"
  region = "us"
  certificate_management_policy {
    authority        = "letsencrypt"
    private_key_type = "ecdsa"
  }
}

For more details, see the Terraform Provider documentation.

Getting Started

Use Cases

Examples

Connectivity

Traffic Policy

Observability

Network

Resources

Identity & Access

Manage ngrok Programmatically With Terraform and API Client Libraries

API client libraries

Terraform provider