Skip to content

Repository files navigation

hero illustration

OpenRouter Terraform Provider

The OpenRouter Terraform Provider lets you manage OpenRouter as infrastructure-as-code: API keys, guardrails, workspaces, BYOK provider credentials, and observability destinations — with full lifecycle support, drift detection, and import.

To learn more about the underlying platform, check out the OpenRouter Documentation. Reference docs for every resource and data source are on the Terraform Registry.

Built by Speakeasy License: MIT

Installation

To install this provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    openrouter = {
      source  = "OpenRouterTeam/openrouter"
      version = "0.2.128"
    }
  }
}

provider "openrouter" {
  server_url = "..." # Optional
}

Provider Usage

Authenticate with a Management API key (sk-or-mgmt-...) — management keys administer resources but cannot spend inference credits.

provider "openrouter" {
  api_key = var.openrouter_management_key
}

resource "openrouter_workspace" "production" {
  name = "Production"
  slug = "production"
}

resource "openrouter_api_key" "backend" {
  name         = "backend-service"
  limit        = 100 # monthly credit limit in USD
  limit_reset  = "monthly"
  workspace_id = openrouter_workspace.production.id
}

resource "openrouter_guardrail" "cost_cap" {
  name           = "cost-cap"
  limit_usd      = 50
  reset_interval = "monthly"
  enforce_zdr    = true
}

Authentication

This provider supports authentication configuration via environment variables and provider configuration.

The configuration precedence is:

  • Provider configuration
  • Environment variables

Available configuration:

Provider Attribute Description
api_key API key as bearer token in Authorization header. Configurable via environment variable OPENROUTER_MANAGEMENT_KEY.

Available Resources and Data Sources

Managed Resources

Data Sources

Testing the provider locally

Local Provider

Should you want to validate a change locally, the --debug flag allows you to execute the provider against a terraform instance locally.

This also allows for debuggers (e.g. delve) to be attached to the provider.

go run main.go --debug
# Copy the TF_REATTACH_PROVIDERS env var
# In a new terminal
cd examples/your-example
TF_REATTACH_PROVIDERS=... terraform init
TF_REATTACH_PROVIDERS=... terraform apply

Compiled Provider

Terraform allows you to use local provider builds by setting a dev_overrides block in a configuration file called .terraformrc. This block overrides all other configured installation methods.

  1. Execute go build to construct a binary called terraform-provider-openrouter
  2. Ensure that the .terraformrc file is configured with a dev_overrides section such that your local copy of terraform can see the provider binary

Terraform searches for the .terraformrc file in your home directory and applies any configuration settings you set.

provider_installation {

  dev_overrides {
      "registry.terraform.io/OpenRouterTeam/openrouter" = "<PATH>"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}

Development

Contributions

While we value open-source contributions to this terraform provider, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

Official Terraform provider for OpenRouter — manage API keys, guardrails, workspaces, BYOK credentials, and observability destinations as infrastructure-as-code

Topics

Resources

Contributing

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages