Registry

GetTerraformModuleVersion

Retrieves the detail for a specific version of a Terraform module, including the README and the inputs, outputs, and provider requirements parsed from the tarball at publish time. The module is identified by its registry source, publisher organization, and the module name and provider system joined by a hyphen (e.g. 'vpc-aws'). The version may be a semantic version string or 'latest'. Returns 404 if the module version does not exist. This endpoint is in Preview and its shape may change.

get/api/registry/terraform-modules/{source}/{publisher}/{name}/versions/{version}

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/registry/terraform-modules/{source}/{publisher}/{name}/versions/{version}
  • Auth: none declared

Path parameters

sourcestring required

The registry source name (e.g. 'private' for private modules, or the interim public source such as 'pulumi')

publisherstring required

Organization that owns the module

namestring required

The module name and provider system joined by a hyphen (e.g. 'vpc-aws'); split on the last hyphen

versionstring required

Semantic version string or 'latest'

Response

OK

descriptionstring

A free-form text description of the module's purpose.

latestVersionstring required

The latest published semantic version of the module.

namestring required

The module name.

publisherstring required

The organization or user that published the module (the Terraform namespace).

sourcestring required

The source identifier indicating where the module originates from (e.g. 'private').

systemstring required

The Terraform provider system the module targets (e.g. 'aws', 'azurerm', 'google').

updatedAtstring date-time required

The timestamp when the module was last updated.

urlstring required

The canonical registry:// URL identifying the module.

readmestring

The module README, rendered client-side. Absent when the module ships no README.

sha256string required

The SHA-256 checksum of the module tarball.

sizeBytesinteger required

The size of the module tarball in bytes.

versionstring required

The semantic version of this module version.

terraformSourceAddressstring

The Terraform/OpenTofu source address ("<host>/<namespace>/<name>/<system>") used to consume the module from a module block or pulumi package add terraform-module. Empty when the registry host is not configured.

Changes

No recorded changes to this operation across all 1 revision of this API.