Registry

GetTemplateVersion

Retrieves metadata for a specific version of a registry template. The template is identified by its source (e.g. 'private', 'github', or 'gitlab'), publisher organization, and name. The version parameter accepts either a specific semantic version string or the special value 'latest' to retrieve the most recent version. The response includes the template's name, display name, description, runtime information, language, readme URL, download URL (a pre-signed URL valid for at least 5 minutes for retrieving the .tar.gz archive), repository slug (for VCS-backed templates), visibility, updated timestamp, metadata, and configuration values. Returns 400 if a specific version is provided for VCS-backed templates (which do not support versioning), or 404 if the template version does not exist.

get/api/registry/templates/{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/templates/{source}/{publisher}/{name}/versions/{version}
  • Auth: none declared

Path parameters

sourcestring required

The template source: 'private', 'github', or 'gitlab'

publisherstring required

Organization that owns the template

namestring required

The template name

versionstring required

Semantic version string or 'latest'

Response

OK

configobject

Configuration values for the template.

descriptionstring

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

displayNamestring required

The human-readable display name shown in the UI.

downloadURLstring required

An URL, valid for at least 5 minutes that you can retrieve the full download bundle for your template.

The bundle will be a .tar.gz.

language'unknown' | 'python' | 'go' | 'dotnet' | 'java' | 'javascript' | 'typescript' | 'yaml' required

The language that the template is in, inferred from the runtime. This may differ from the runtime (e.g., dotnet runtime with C# language, nodejs runtime with TypeScript language) or be the same (e.g., python).

metadataobject

Key-value metadata associated with the template.

namestring required

The unique identifier name of the template.

publisherstring required

The organization or user that published the template.

readmeURLstring

ReadmeURL is just a pre-signed URL, derived from the artifact key.

repoSlugstring

A link to the hosting repository. Non-VCS backed templates do not have a repo slug as of now.

sourcestring required

The source identifier indicating where the template originates from.

updatedAtstring date-time required

The timestamp when the template was last updated.

urlstring required

For registry-backed templates, the URL will be a registry:// URL. For VCS-backed templates, this will be the VCS URL (e.g., GitHub, GitLab).

visibility'public' | 'private' required

The visibility of the template (public or private).

Changes

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