Terraform Registry
App · 14 actions
Look things up in the public Terraform Registry, no account needed: search and read modules (their inputs, outputs and resources), find providers and their versions, platforms, downloads and documentation, browse Sentinel policy libraries, and start a workflow when a provider or module you follow publishes a new version.
Actions
| Action | What it does |
|---|---|
| Get a module | Get one version of a module in full: what it does, its input variables (required ones first) and outputs, the resources it creates, the providers it needs, its submodules and examples, its downloads, and the module block to paste into a configuration. |
| Get a module's download source | Get where Terraform downloads a version of a module from: the source address the registry hands Terraform, split into its repository, the exact Git commit or tag, and any folder inside it. |
| Get a policy library | Get one Sentinel policy library: what it checks, its versions, and every policy in it with a summary of what each one enforces. |
| Get a provider | Get one provider: what it manages, who publishes it, its tier and categories, its latest version, its downloads over the last week, month and year, and the required_providers block to paste into a configuration. |
| Get a provider doc page | Read one page of a provider's documentation, such as the aws_instance resource, in Markdown: its arguments, attributes and examples, ready to summarise or send on. |
| Get a provider download | Get the zip file of a provider version for one operating system and processor: its download link, SHA-256 checksum, the signed checksums file and the keys it is signed with, and the plugin protocols it speaks. |
| Get a provider version | Get one version of a provider (the latest by default): when it was published, how often it has been downloaded, and every operating system and processor it is built for. |
| List module versions | List every version of a module, newest first, with when each was published and how often it has been downloaded, and say which is the latest. |
| List modules | List the registry's modules, most downloaded first, narrowed to a publisher (such as terraform-aws-modules), a provider, an exact name or partner modules, with how many match in all. |
| List policy libraries | List the registry's Sentinel policy libraries (ready-made compliance checks for Terraform plans, such as the CIS benchmarks for AWS), most downloaded first, optionally for one publisher or one provider. |
| List provider docs | List the documentation pages of a provider version (its resources, data sources, functions, guides and more), optionally one section or the pages whose name contains some words, with each page's id and link. |
| List provider versions | List every version of a provider, newest first, with when each was published and how often it has been downloaded, and say which is the latest. |
| List providers | List the registry's providers (the plugins Terraform uses to manage a cloud or service, such as AWS or GitHub), narrowed by publisher, type, tier or category, with each one's latest version and how many match in all. |
| Search modules | Search the public registry's modules (ready-made Terraform building blocks, such as a VPC or a Kubernetes cluster) by keyword, best match first, optionally only for one provider, one publisher or partner modules. |
Get a module
Get one version of a module in full: what it does, its input variables (required ones first) and outputs, the resources it creates, the providers it needs, its submodules and examples, its downloads, and the module block to paste into a configuration.
Inputs
- Module
moduletextRequired - The module's address, namespace/name/provider like terraform-aws-modules/vpc/aws, or a link to its page on registry.terraform.io. Search modules finds it.
- Version
versiontext - A version of the module, such as 6.7.3. Leave empty for the latest.
- Include the README
include_readmetrue/false - Also return the README, in Markdown. It can be long; off by default.Default:
false.
Outputs
addresstext- The module's address, namespace/name/provider, e.g. terraform-aws-modules/vpc/aws: the source a Terraform module block uses.
deprecatedtrue/false- True when its publisher has deprecated it.
descriptiontext- What it does, in its author's words.
downloadsnumber- How many times it has been downloaded, all versions.
downloads_monthnumber- Downloads in the last month.
downloads_weeknumber- Downloads in the last week.
downloads_yearnumber- Downloads in the last year.
exampleslist- Its examples.
inputslist- Its input variables, required ones first.
is_latesttrue/false- True when the version shown is the latest.
latest_versiontext- Its latest version.
module_dependencieslist- Other modules it calls.
nametext- The module's name.
namespacetext- Who publishes it.
outputslist- Its outputs.
ownertext- The registry user who published it.
providertext- The provider it is written for.
provider_requirementslist- The providers it needs.
published_attext- When this version was published, as an ISO 8601 UTC instant.
readmetext- Its README in Markdown, with Include the README on.
registry_urltext- This version's page on registry.terraform.io.
required_input_countnumber- How many inputs must be given.
resourceslist- The resources it creates.
source_urltext- Its source code repository.
submoduleslist- Its submodules.
tagtext- The Git tag this version was published from.
usagetext- The module block to paste into a configuration.
verifiedtrue/false- True for a partner module.
versiontext- The version shown.
version_countnumber- How many versions it has.
Example output
{
"address": "terraform-google-modules/network/google",
"deprecated": false,
"description": "Sets up a new VPC network on Google Cloud",
"downloads": 69247136,
"downloads_month": 1204008,
"downloads_week": 477082,
"downloads_year": 18381987,
"examples": [
{
"name": "simple_project",
"path": "examples/simple_project"
}
],
"inputs": [
{
"default": null,
"description": "The name of the network being created",
"name": "network_name",
"required": true,
"type": "string"
},
{
"default": "\"GLOBAL\"",
"description": "The network routing mode",
"name": "routing_mode",
"required": false,
"type": "string"
}
],
"is_latest": true,
"latest_version": "18.3.1",
"module_dependencies": [
{
"name": "vpc",
"source": "./modules/vpc",
"version": null
}
],
"name": "network",
"namespace": "terraform-google-modules",
"outputs": [
{
"description": "The ID of the VPC",
"name": "network_id"
}
],
"owner": "cloud-foundation-bot",
"provider": "google",
"provider_requirements": [
{
"name": "google",
"source": "hashicorp/google",
"version_constraint": ">= 4.64, < 9"
}
],
"published_at": "2026-10-08T07:59:41Z",
"readme": null,
"registry_url": "https://registry.terraform.io/modules/terraform-google-modules/network/google/18.3.1",
"required_input_count": 1,
"resources": [
{
"address": "google_compute_network.network",
"name": "network",
"type": "google_compute_network"
}
],
"source_url": "https://github.com/terraform-google-modules/terraform-google-network",
"submodules": [
{
"name": "routes",
"path": "modules/routes"
}
],
"tag": "v18.3.1",
"usage": "module \"network\" {\n source = \"terraform-google-modules/network/google\"\n version = \"18.3.1\"\n # insert the 1 required variable here\n}",
"verified": true,
"version": "18.3.1",
"version_count": 83
}Get a module's download source
Get where Terraform downloads a version of a module from: the source address the registry hands Terraform, split into its repository, the exact Git commit or tag, and any folder inside it.
Inputs
- Module
moduletextRequired - The module's address, namespace/name/provider like terraform-aws-modules/vpc/aws, or a link to its page on registry.terraform.io. Search modules finds it.
- Version
versiontext - A version of the module, such as 6.7.3. Leave empty for the latest.
Outputs
addresstext- The module's address, namespace/name/provider, e.g. terraform-aws-modules/vpc/aws: the source a Terraform module block uses.
download_sourcetext- The source address exactly as the registry gives it, e.g. git::https://github.com/org/repo?ref=<commit>.
reftext- The Git commit or tag it is pinned to.
registry_urltext- This version's page on registry.terraform.io.
repository_urltext- The repository it is fetched from.
source_typetext- How it is fetched, e.g. git.
subdirectorytext- The folder inside the repository, if it is not the top.
versiontext- The version this source is for.
Example output
{
"address": "terraform-aws-modules/vpc/aws",
"download_source": "git::https://github.com/terraform-aws-modules/terraform-aws-vpc?ref=b3abd6df2ecf052451a361ed55b8f06f8742a795",
"ref": "b3abd6df2ecf052451a361ed55b8f06f8742a795",
"registry_url": "https://registry.terraform.io/modules/terraform-aws-modules/vpc/aws/6.7.3",
"repository_url": "https://github.com/terraform-aws-modules/terraform-aws-vpc",
"source_type": "git",
"subdirectory": null,
"version": "6.7.3"
}Get a policy library
Get one Sentinel policy library: what it checks, its versions, and every policy in it with a summary of what each one enforces.
Inputs
- Policy library
librarytextRequired - The library's address, namespace/name like hashicorp/CIS-Policy-Set-for-AWS-Terraform, or a link to its page. List policy libraries finds it.
- Version
versiontext - A version of the library, such as 1.0.2. Leave empty for the latest.
- Include the README
include_readmetrue/false - Also return the README, in Markdown. It can be long; off by default.Default:
false.
Outputs
addresstext- The policy library's address, namespace/name, e.g. hashicorp/CIS-Policy-Set-for-AWS-Terraform.
descriptiontext- What it checks, in its author's words.
downloadsnumber- How many times this version has been downloaded.
latest_versiontext- Its latest version.
moduleslist- The Sentinel modules its policies share.
nametext- The library's name.
namespacetext- Who publishes it.
policieslist- Every policy in this version.
policy_countnumber- How many policies it has.
published_attext- When this version was published, as an ISO 8601 UTC instant.
readmetext- Its README in Markdown, with Include the README on.
registry_urltext- This version's page on registry.terraform.io.
source_urltext- Its source code repository.
titletext- Its title.
verifiedtrue/false- True for a library the registry has verified.
versiontext- The version shown.
versionslist- Every version it has, newest first.
Example output
{
"address": "hashicorp/CIS-Policy-Set-for-AWS-Terraform",
"description": "AWS CIS Policy Set for Terraform",
"downloads": 48943,
"latest_version": "1.0.2",
"modules": [
{
"name": "report",
"path": "modules/report/report.sentinel"
}
],
"name": "CIS-Policy-Set-for-AWS-Terraform",
"namespace": "hashicorp",
"policies": [
{
"downloads": 1407,
"name": "iam-password-numbers",
"summary": "Password policies, in part, enforce password complexity requirements.",
"title": "AWS IAM Password Policy requires at least one number"
}
],
"policy_count": 1,
"published_at": "2026-03-20T06:46:48Z",
"readme": null,
"registry_url": "https://registry.terraform.io/policies/hashicorp/CIS-Policy-Set-for-AWS-Terraform/1.0.2",
"source_url": "https://github.com/hashicorp/policy-library-CIS-Policy-Set-for-AWS-Terraform",
"title": "Pre-written Sentinel Policies for AWS CIS Foundations Benchmarking",
"verified": false,
"version": "1.0.2",
"versions": [
"1.0.2",
"1.0.1",
"1.0.0"
]
}Get a provider
Get one provider: what it manages, who publishes it, its tier and categories, its latest version, its downloads over the last week, month and year, and the required_providers block to paste into a configuration.
Inputs
- Provider
providertextRequired - Pick an official or partner provider, or type any provider's address, namespace/type like hashicorp/aws (a bare type like aws means hashicorp/aws), or paste a link to its page.
Outputs
addresstext- The provider's address, namespace/type, e.g. hashicorp/aws: the source a required_providers block uses.
aliastext- The short name Terraform knows it by, if any.
categorieslist- The registry categories it is filed under.
descriptiontext- What it manages, in its author's words.
docs_urltext- Its documentation on registry.terraform.io.
downloadsnumber- How many times it has been downloaded, all versions.
downloads_monthnumber- Downloads in the last month.
downloads_weeknumber- Downloads in the last week.
downloads_yearnumber- Downloads in the last year.
featuredtrue/false- True when the registry features it on its home page.
latest_published_attext- When its latest version was published, as an ISO 8601 UTC instant.
latest_tagtext- The Git tag its latest version was published from.
latest_versiontext- Its latest version.
logo_urltext- Its logo.
nametext- The provider's type, e.g. aws.
namespacetext- Who publishes it, e.g. hashicorp.
registry_urltext- Its page on registry.terraform.io.
source_urltext- Its source code repository.
tiertext- official (by HashiCorp), partner (by the technology's own company) or community.
usagetext- The required_providers block to paste into a configuration, pinned to the latest version.
warningtext- A warning the registry shows on its page, such as that it is archived. Empty when there is none.
Example output
{
"address": "hashicorp/aws",
"alias": "aws",
"categories": [
"Public Cloud"
],
"description": "Lifecycle management of AWS resources, including EC2, Lambda, EKS, ECS, VPC, S3, RDS, DynamoDB, and more.",
"docs_url": "https://registry.terraform.io/providers/hashicorp/aws/latest/docs",
"downloads": 8104234207,
"downloads_month": 164102027,
"downloads_week": 57737260,
"downloads_year": 2718589808,
"featured": true,
"latest_published_at": "2026-10-22T01:11:12Z",
"latest_tag": "v6.70.0",
"latest_version": "6.70.0",
"logo_url": "https://registry.terraform.io/images/providers/aws.png",
"name": "aws",
"namespace": "hashicorp",
"registry_url": "https://registry.terraform.io/providers/hashicorp/aws/latest",
"source_url": "https://github.com/hashicorp/terraform-provider-aws",
"tier": "official",
"usage": "terraform {\n required_providers {\n aws = {\n source = \"hashicorp/aws\"\n version = \"6.70.0\"\n }\n }\n}\n\nprovider \"aws\" {\n # Configuration options\n}",
"warning": null
}Get a provider doc page
Read one page of a provider's documentation, such as the aws_instance resource, in Markdown: its arguments, attributes and examples, ready to summarise or send on.
Inputs
- Provider
providertext - The provider whose docs to read, such as hashicorp/aws. Leave empty when Page is a link to the doc page or its id.
- Section
categorytext - The section the page is in. Resources by default.One of:
resources,data-sources(Data sources),ephemeral-resources(Ephemeral resources),list-resources(List resources),functions,actions,guides,overview. Default:resources. - Page
pagetextRequired - The page's name, such as instance; a resource type, such as aws_instance; its id from List provider docs; or a link to the page on registry.terraform.io.
- Version
versiontext - A version of the provider, such as 6.70.0. Leave empty for the latest.
Outputs
addresstext- The provider the page belongs to. Empty when only an id was given.
categorytext- The section the page is in, e.g. resources.
contenttext- The page in Markdown.
descriptiontext- The page's one-line summary.
idtext- The page's id.
page_titletext- The page's full title, e.g. AWS: aws_instance.
registry_urltext- The page on registry.terraform.io. Empty when only an id was given.
slugtext- The page's name in its address, e.g. instance.
subcategorytext- The group the page is filed under.
titletext- The page's title, e.g. instance.
truncatedtrue/false- True when the registry cut a very long page short.
versiontext- The provider version the page is from.
Example output
{
"address": "hashicorp/random",
"category": "resources",
"content": "# random_password (Resource)\n\nIdentical to random_string with the exception that the result is treated as sensitive.",
"description": "Identical to random_string with the exception that the result is treated as sensitive.",
"id": "13616547",
"page_title": "random_password Resource - terraform-provider-random",
"registry_url": "https://registry.terraform.io/providers/hashicorp/random/3.9.1/docs/resources/password",
"slug": "password",
"subcategory": null,
"title": "password",
"truncated": false,
"version": "3.9.1"
}Get a provider download
Get the zip file of a provider version for one operating system and processor: its download link, SHA-256 checksum, the signed checksums file and the keys it is signed with, and the plugin protocols it speaks.
Inputs
- Provider
providertextRequired - Pick an official or partner provider, or type any provider's address, namespace/type like hashicorp/aws (a bare type like aws means hashicorp/aws), or paste a link to its page.
- Operating system
ostext - The operating system to download for. Linux by default.One of:
linux,darwin(macOS (darwin)),windows,freebsd,openbsd,solaris. Default:linux. - Processor
archtext - The processor to download for. amd64 by default.One of:
amd64(amd64 (64-bit Intel or AMD)),arm64(arm64 (64-bit ARM, such as Apple silicon or Graviton)),386(386 (32-bit Intel)),arm(arm (32-bit ARM)),s390x(s390x (IBM Z mainframes)). Default:amd64. - Version
versiontext - A version of the provider, such as 6.70.0. Leave empty for the latest.
Outputs
addresstext- The provider's address, namespace/type, e.g. hashicorp/aws: the source a required_providers block uses.
archtext- The processor it is built for.
download_urltext- Where to download the zip file.
filenametext- The zip file's name.
ostext- The operating system it is built for.
protocolslist- The plugin protocol versions it speaks, e.g. 5.0. Protocol 6 needs Terraform 1.0 or later.
shasumtext- The zip file's SHA-256 checksum.
shasums_signature_urltext- The signature of that checksums file.
shasums_urltext- The file listing every build's checksum.
signing_keyslist- The public keys the checksums file is signed with.
versiontext- The version downloaded.
Example output
{
"address": "hashicorp/random",
"arch": "arm64",
"download_url": "https://releases.hashicorp.com/terraform-provider-random/3.9.1/terraform-provider-random_3.9.1_darwin_arm64.zip",
"filename": "terraform-provider-random_3.9.1_darwin_arm64.zip",
"os": "darwin",
"protocols": [
"5.0"
],
"shasum": "19388a4074b76a89a43a6c8328d7ae8ee2e7de3d346af51e80d3e6d3d12925f1",
"shasums_signature_url": "https://releases.hashicorp.com/terraform-provider-random/3.9.1/terraform-provider-random_3.9.1_SHA256SUMS.72D7468F.sig",
"shasums_url": "https://releases.hashicorp.com/terraform-provider-random/3.9.1/terraform-provider-random_3.9.1_SHA256SUMS",
"signing_keys": [
{
"ascii_armor": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQINBGB9+xkBEACabYZOWKmg\n-----END PGP PUBLIC KEY BLOCK-----",
"key_id": "34365D9472D7468F",
"source": "HashiCorp",
"source_url": "https://www.hashicorp.com/security.html",
"trust_signature": null
}
],
"version": "3.9.1"
}Get a provider version
Get one version of a provider (the latest by default): when it was published, how often it has been downloaded, and every operating system and processor it is built for.
Inputs
- Provider
providertextRequired - Pick an official or partner provider, or type any provider's address, namespace/type like hashicorp/aws (a bare type like aws means hashicorp/aws), or paste a link to its page.
- Version
versiontext - A version of the provider, such as 6.70.0. Leave empty for the latest.
Outputs
addresstext- The provider's address, namespace/type, e.g. hashicorp/aws: the source a required_providers block uses.
docs_urltext- This version's documentation on registry.terraform.io.
downloadsnumber- How many times this version has been downloaded.
is_prereleasetrue/false- True for a pre-release such as 6.0.0-beta1.
platform_countnumber- How many platforms it is built for.
platformslist- Every operating system and processor it is built for.
published_attext- When it was published, as an ISO 8601 UTC instant.
registry_urltext- This version's page on registry.terraform.io.
tagtext- The Git tag it was published from.
usagetext- The required_providers block to paste into a configuration, pinned to this version.
versiontext- The version number.
Example output
{
"address": "hashicorp/random",
"docs_url": "https://registry.terraform.io/providers/hashicorp/random/3.9.1/docs",
"downloads": 116315069,
"is_prerelease": false,
"platform_count": 1,
"platforms": [
{
"arch": "amd64",
"downloads": 98119354,
"os": "linux",
"platform": "linux_amd64"
}
],
"published_at": "2026-09-11T15:17:02Z",
"registry_url": "https://registry.terraform.io/providers/hashicorp/random/3.9.1",
"tag": "v3.9.1",
"usage": "terraform {\n required_providers {\n random = {\n source = \"hashicorp/random\"\n version = \"3.9.1\"\n }\n }\n}\n\nprovider \"random\" {\n # Configuration options\n}",
"version": "3.9.1"
}List module versions
List every version of a module, newest first, with when each was published and how often it has been downloaded, and say which is the latest.
Inputs
- Module
moduletextRequired - The module's address, namespace/name/provider like terraform-aws-modules/vpc/aws, or a link to its page on registry.terraform.io. Search modules finds it.
- Include pre-releases
include_prereleasestrue/false - Also list pre-releases such as 6.0.0-beta1. On by default.Default:
true. - Number of versions
limitnumber - How many to return, 1 to 1,000. 50 by default.From 1 to 1000. Default:
50.
Outputs
addresstext- The module's address, namespace/name/provider, e.g. terraform-aws-modules/vpc/aws: the source a Terraform module block uses.
countnumber- How many are in this page.
latest_published_attext- When its latest version was published, as an ISO 8601 UTC instant.
latest_versiontext- Its latest version.
registry_urltext- The module's page on registry.terraform.io.
total_countnumber- How many versions it has, with this filter.
versionslist- The versions, newest first.
Example output
{
"address": "terraform-aws-modules/vpc/aws",
"count": 1,
"latest_published_at": "2026-09-18T19:52:23Z",
"latest_version": "6.7.3",
"registry_url": "https://registry.terraform.io/modules/terraform-aws-modules/vpc/aws/latest",
"total_count": 244,
"versions": [
{
"downloads": 2375907,
"is_prerelease": false,
"published_at": "2026-09-18T19:52:23Z",
"registry_url": "https://registry.terraform.io/modules/terraform-aws-modules/vpc/aws/6.7.3",
"tag": "v6.7.3",
"version": "6.7.3"
}
]
}List modules
List the registry's modules, most downloaded first, narrowed to a publisher (such as terraform-aws-modules), a provider, an exact name or partner modules, with how many match in all.
Inputs
- Namespace
namespacetext - Only those published by this namespace (a GitHub user or organization), such as hashicorp.
- Provider
providertext - Only modules written for this provider, by its type, such as aws, google or azurerm.
- Name
nametext - Only modules with exactly this name, such as vpc, from every publisher.
- Partner modules only
verified_onlytrue/false - Only partner modules, published and kept up by the technology's own company. Off by default.Default:
false. - Number of modules
limitnumber - How many to return, 1 to 100. 20 by default.From 1 to 100. Default:
20. - Page
pagenumber - Which page to return, from 1: use next_page from the last one.At least 1. Default:
1.
Outputs
countnumber- How many are in this page.
has_moretrue/false- True when more follow on the next page.
moduleslist- The modules in this page, most downloaded first.
next_pagenumber- The page number to ask for next. Empty on the last page.
pagenumber- The page number returned, from 1.
total_countnumber- How many match in all, across every page.
total_pagesnumber- How many pages there are at this page size.
Example output
{
"count": 1,
"has_more": true,
"modules": [
{
"address": "terraform-aws-modules/vpc/aws",
"description": "Terraform module to create AWS VPC resources",
"downloads": 223876186,
"name": "vpc",
"namespace": "terraform-aws-modules",
"owner": "antonbabenko",
"provider": "aws",
"published_at": "2026-09-18T19:52:23Z",
"registry_url": "https://registry.terraform.io/modules/terraform-aws-modules/vpc/aws/6.7.3",
"source_url": "https://github.com/terraform-aws-modules/terraform-aws-vpc",
"verified": false,
"version": "6.7.3"
}
],
"next_page": 2,
"page": 1,
"total_count": 57,
"total_pages": 57
}List policy libraries
List the registry's Sentinel policy libraries (ready-made compliance checks for Terraform plans, such as the CIS benchmarks for AWS), most downloaded first, optionally for one publisher or one provider.
Inputs
- Namespace
namespacetext - Only libraries published by this namespace, such as hashicorp.
- Provider
providertext - Only libraries with policies for this provider, by its type, such as aws, google or azurerm.
- Number of libraries
limitnumber - How many to return, 1 to 100. 20 by default.From 1 to 100. Default:
20. - Page
pagenumber - Which page to return, from 1: use next_page from the last one.At least 1. Default:
1.
Outputs
countnumber- How many are in this page.
has_moretrue/false- True when more follow on the next page.
librarieslist- The libraries in this page.
next_pagenumber- The page number to ask for next. Empty on the last page.
pagenumber- The page number returned, from 1.
total_countnumber- How many match in all, across every page.
total_pagesnumber- How many pages there are at this page size.
Example output
{
"count": 1,
"has_more": true,
"libraries": [
{
"address": "hashicorp/CIS-Policy-Set-for-AWS-Terraform",
"description": "AWS CIS Policy Set for Terraform",
"downloads": 962659,
"latest_published_at": "2026-03-20T06:46:48Z",
"latest_version": "1.0.2",
"name": "CIS-Policy-Set-for-AWS-Terraform",
"namespace": "hashicorp",
"registry_url": "https://registry.terraform.io/policies/hashicorp/CIS-Policy-Set-for-AWS-Terraform/latest",
"source_url": "https://github.com/hashicorp/policy-library-CIS-Policy-Set-for-AWS-Terraform",
"title": "Pre-written Sentinel Policies for AWS CIS Foundations Benchmarking",
"verified": false
}
],
"next_page": 2,
"page": 1,
"total_count": 38,
"total_pages": 38
}List provider docs
List the documentation pages of a provider version (its resources, data sources, functions, guides and more), optionally one section or the pages whose name contains some words, with each page's id and link.
Inputs
- Provider
providertextRequired - Pick an official or partner provider, or type any provider's address, namespace/type like hashicorp/aws (a bare type like aws means hashicorp/aws), or paste a link to its page.
- Version
versiontext - A version of the provider, such as 6.70.0. Leave empty for the latest.
- Section
categorytext - Only pages in this section of the docs. Leave empty for every section.One of:
resources,data-sources(Data sources),ephemeral-resources(Ephemeral resources),list-resources(List resources),functions,actions,guides,overview. - Search
searchtext - Only pages whose name or group contains these words, such as lambda or aws_s3_bucket.
- Number of pages
limitnumber - How many to return, 1 to 1,000. 100 by default.From 1 to 1000. Default:
100. - Skip
offsetnumber - How many to skip, to get the next page: use next_offset from the last one.At least 0. Default:
0.
Outputs
addresstext- The provider's address, namespace/type, e.g. hashicorp/aws: the source a required_providers block uses.
category_countsobject- How many pages each section of this version's docs has, e.g. {"resources": 1736}.
countnumber- How many are in this page.
docslist- The pages in this page of results.
has_moretrue/false- True when more follow on the next page.
next_offsetnumber- The Skip value that gets the next page. Empty on the last page.
total_countnumber- How many pages match, across every page of results.
versiontext- The provider version the pages are for.
Example output
{
"address": "hashicorp/aws",
"category_counts": {
"data-sources": 682,
"overview": 1,
"resources": 1736
},
"count": 1,
"docs": [
{
"category": "data-sources",
"id": "14297840",
"registry_url": "https://registry.terraform.io/providers/hashicorp/aws/6.70.0/docs/data-sources/lambda_function",
"slug": "lambda_function",
"subcategory": "Lambda",
"title": "lambda_function"
}
],
"has_more": true,
"next_offset": 1,
"total_count": 9,
"version": "6.70.0"
}List provider versions
List every version of a provider, newest first, with when each was published and how often it has been downloaded, and say which is the latest.
Inputs
- Provider
providertextRequired - Pick an official or partner provider, or type any provider's address, namespace/type like hashicorp/aws (a bare type like aws means hashicorp/aws), or paste a link to its page.
- Include pre-releases
include_prereleasestrue/false - Also list pre-releases such as 6.0.0-beta1. On by default.Default:
true. - Number of versions
limitnumber - How many to return, 1 to 1,000. 50 by default.From 1 to 1000. Default:
50.
Outputs
addresstext- The provider's address, namespace/type, e.g. hashicorp/aws: the source a required_providers block uses.
countnumber- How many are in this page.
latest_published_attext- When its latest version was published, as an ISO 8601 UTC instant.
latest_versiontext- Its latest version.
registry_urltext- The provider's page on registry.terraform.io.
total_countnumber- How many versions it has, with this filter.
versionslist- The versions, newest first.
Example output
{
"address": "hashicorp/aws",
"count": 1,
"latest_published_at": "2026-10-22T01:11:12Z",
"latest_version": "6.70.0",
"registry_url": "https://registry.terraform.io/providers/hashicorp/aws/latest",
"total_count": 513,
"versions": [
{
"downloads": 1204551,
"is_prerelease": false,
"published_at": "2026-10-22T01:11:12Z",
"registry_url": "https://registry.terraform.io/providers/hashicorp/aws/6.70.0",
"tag": "v6.70.0",
"version": "6.70.0"
}
]
}List providers
List the registry's providers (the plugins Terraform uses to manage a cloud or service, such as AWS or GitHub), narrowed by publisher, type, tier or category, with each one's latest version and how many match in all.
Inputs
- Namespace
namespacetext - Only providers published by this namespace, such as hashicorp or integrations.
- Type
nametext - Only providers of exactly this type, such as github, from every publisher. Can't be combined with Category.
- Tiers
tierslist - Only these tiers: official (by HashiCorp), partner (by the technology's own company) or community. Leave empty for all.One or more of:
official(Official, by HashiCorp),partner(Partner, by the technology's own company),community. - Category
categorytext - Only providers in this category, such as Database or Networking. Leave empty when Type is set.
- Featured only
featured_onlytrue/false - Only the providers featured on the registry's home page. Off by default.Default:
false. - Order
sorttext - Most downloaded first by default.One of:
downloads(Most downloaded first),name(By name, A to Z),tier(Official first, then partner, then community). Default:downloads. - Number of providers
limitnumber - How many to return, 1 to 100. 20 by default.From 1 to 100. Default:
20. - Page
pagenumber - Which page to return, from 1: use next_page from the last one.At least 1. Default:
1.
Outputs
countnumber- How many are in this page.
has_moretrue/false- True when more follow on the next page.
next_pagenumber- The page number to ask for next. Empty on the last page.
pagenumber- The page number returned, from 1.
providerslist- The providers in this page.
total_countnumber- How many match in all, across every page.
total_pagesnumber- How many pages there are at this page size.
Example output
{
"count": 1,
"has_more": true,
"next_page": 2,
"page": 1,
"providers": [
{
"address": "hashicorp/aws",
"description": "Lifecycle management of AWS resources, including EC2, Lambda, EKS, ECS, VPC, S3, RDS, DynamoDB, and more.",
"downloads": 8104234207,
"featured": true,
"latest_published_at": "2026-10-22T01:11:12Z",
"latest_version": "6.70.0",
"logo_url": "https://registry.terraform.io/images/providers/aws.png",
"name": "aws",
"namespace": "hashicorp",
"registry_url": "https://registry.terraform.io/providers/hashicorp/aws/latest",
"source_url": "https://github.com/hashicorp/terraform-provider-aws",
"tier": "official",
"warning": null
}
],
"total_count": 32,
"total_pages": 32
}Search modules
Search the public registry's modules (ready-made Terraform building blocks, such as a VPC or a Kubernetes cluster) by keyword, best match first, optionally only for one provider, one publisher or partner modules. A page at a time.
Inputs
- Search for
querytextRequired - Words to look for in module names and descriptions, such as vpc or kubernetes cluster.
- Provider
providertext - Only modules written for this provider, by its type, such as aws, google or azurerm.
- Namespace
namespacetext - Only those published by this namespace (a GitHub user or organization), such as hashicorp.
- Partner modules only
verified_onlytrue/false - Only partner modules, published and kept up by the technology's own company. Off by default.Default:
false. - Number of modules
limitnumber - How many to return, 1 to 100. 20 by default.From 1 to 100. Default:
20. - Skip
offsetnumber - How many to skip, to get the next page: use next_offset from the last one.At least 0. Default:
0.
Outputs
countnumber- How many are in this page.
has_moretrue/false- True when more follow on the next page.
moduleslist- The matching modules, best first.
next_offsetnumber- The Skip value that gets the next page. Empty on the last page.
querytext- The words searched for.
Example output
{
"count": 1,
"has_more": true,
"modules": [
{
"address": "terraform-aws-modules/vpc/aws",
"description": "Terraform module to create AWS VPC resources",
"downloads": 223876186,
"name": "vpc",
"namespace": "terraform-aws-modules",
"owner": "antonbabenko",
"provider": "aws",
"published_at": "2026-09-18T19:52:23Z",
"registry_url": "https://registry.terraform.io/modules/terraform-aws-modules/vpc/aws/6.7.3",
"source_url": "https://github.com/terraform-aws-modules/terraform-aws-vpc",
"verified": false,
"version": "6.7.3"
}
],
"next_offset": 1,
"query": "vpc"
}