Registry Preview

Retrieves all registry packages accessible to the caller, with support for filtering, sorting, and pagination. No authentication is required, but authenticated requests may include additional usage statistics per package. Results can be filtered by package name, publisher, owning organization, sort field, and visibility level. Results are paginated with a default limit of 100 per page; use the continuationToken from the response to retrieve subsequent pages. Each entry in the response contains the full package metadata including name, publisher, source, version, title, description, repository URL, category, featured status, package types, maturity status, readme URL, schema URL, creation timestamp, and visibility.

Request Parameters

• asc boolean query optional
  When true, sort results in ascending order
• continuationToken string query optional
  Pagination token for retrieving the next page of results
• limit integer query optional
  Results per page (default: 100)
• name string query optional
  Filter by specific package name
• orgLogin string query optional
  Filter by owning organization
• publisher string query optional
  Filter by publisher organization
• sort string query optional
  Sort field for results
• visibility string query optional
  Filter by visibility level

Responses

Initiates the first step of a two-phase package version publish workflow. This creates a publish transaction and returns an operationID along with pre-signed upload URLs for the package artifacts (schema, index, and installationConfiguration). The caller must upload all required artifacts to the provided URLs and then call the PostPublishPackageVersionComplete endpoint with the operationID to finalize the publish. The request body must include the semantic version to publish. Returns 202 Accepted with the operation details, 404 if the source does not exist, or 409 if the specified version already exists.

Request Parameters

• source string path required
  The package source: ‘pulumi’, ‘opentofu’, or ‘private’
• publisher string path required
  Organization that owns the package
• name string path required
  The package name

Request Body

• version string required
  The semantic version of the package to publish.
• publishedAt string optional
  Optional timestamp for when the package version was originally published. If not provided, defaults to current server time. Useful for backfilling historical versions with their original publish dates.

Responses

Retrieves metadata for a specific version of a registry package. The package is identified by its source, publisher organization, and name. The version parameter accepts either a specific semantic version string or the special value ’latest’ to retrieve the most recently published version. The response includes the package’s name, publisher, version, title, description, repository URL, category, featured status, package types, maturity status, readme URL, schema URL, plugin download URL, creation timestamp, visibility, parameterization details, and usage statistics (when the caller is authenticated). Returns 404 if the specified package version does not exist.

Request Parameters

• source string path required
  The package source: ‘pulumi’, ‘opentofu’, or ‘private’
• publisher string path required
  Organization that owns the package
• name string path required
  The package name
• version string path required
  Semantic version string or ’latest'

Responses

Removes a specific version of a package from the registry. The package is identified by its source (e.g. ‘pulumi’, ‘opentofu’, or ‘private’), publisher organization, name, and semantic version. Requires the RegistryPublish permission on the publisher organization. Returns 204 No Content on success.

Request Parameters

• source string path required
  The package source: ‘pulumi’, ‘opentofu’, or ‘private’
• publisher string path required
  Organization that owns the package
• name string path required
  The package name
• version string path required
  Semantic version string of the package version to delete

Responses

Finalizes the second step of the two-phase package version publish workflow. After initiating a publish with PostPublishPackageVersion and uploading all required artifacts (schema, index, installationConfiguration) to the pre-signed URLs, call this endpoint with the operationID to complete the publish. The service validates that all artifacts were uploaded successfully before making the version available in the registry. Returns 201 Created on success, 400 for a bad request (e.g. missing artifacts), 404 if the publish operation is not found, or 409 if the version already exists.

Request Parameters

• source string path required
  The package source: ‘pulumi’, ‘opentofu’, or ‘private’
• publisher string path required
  Organization that owns the package
• name string path required
  The package name
• version string path required
  Semantic version string of the package version to complete

Request Body

• operationID string required
  The identifier of the publish operation to complete.

Responses

Lists registry-backed templates with optional filtering, search, and pagination. This endpoint returns only registry-backed templates and does not include VCS-backed templates (those sourced from GitHub or GitLab repositories). No authentication is required. Results can be filtered by template name and owning organization (orgLogin). The search parameter performs case-insensitive partial matching against the template name, display name, description, metadata values, and runtime language. Results are paginated with a default limit of 100 per page; use the continuationToken from the response to retrieve subsequent pages. Each entry in the response includes the template’s name, publisher, source, display name, description, runtime, language, readme URL, download URL, visibility, and updated timestamp.

Request Parameters

• continuationToken string query optional
  Pagination token for retrieving the next page of results
• limit integer query optional
  Maximum number of results to return (default: 100)
• name string query optional
  Filter by specific template name
• orgLogin string query optional
  Filter by owning organization
• search string query optional
  Search query matching template name, display name, description, metadata values, or runtime language. Multiple space-separated terms require all terms to match (AND semantics).

Responses

Initiates the first step of a two-phase template version publish workflow. This creates a publish transaction and returns an operationID along with a pre-signed upload URL for the template archive. The source must be ‘private’. The caller must upload the template archive (a gzip-compressed tar file containing a root-level Pulumi.yaml with a template section, and optionally a README.md) to the provided URL, then call PostPublishTemplateVersionComplete with the operationID to finalize the publish. The request body must include the semantic version to publish. Returns 202 Accepted with the operation details, or 404 if the source does not exist.

Request Parameters

• source string path required
  The template source: ‘private’, ‘github’, or ‘gitlab’
• publisher string path required
  Organization that owns the template
• name string path required
  The template name

Request Body

• version string required
  The semantic version of the template to publish.

Responses

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.

Request Parameters

• source string path required
  The template source: ‘private’, ‘github’, or ‘gitlab’
• publisher string path required
  Organization that owns the template
• name string path required
  The template name
• version string path required
  Semantic version string or ’latest'

Responses

Removes a specific version of a template from the registry. The template is identified by its source (e.g. ‘private’, ‘github’, or ‘gitlab’), publisher organization, name, and semantic version. If this is the last remaining version of the template, the ‘force’ query parameter must be set to true; doing so will also delete the template itself. Returns 204 No Content on success, or 400 if an invalid query parameter is provided.

Request Parameters

• source string path required
  The template source: ‘private’, ‘github’, or ‘gitlab’
• publisher string path required
  Organization that owns the template
• name string path required
  The template name
• version string path required
  Semantic version string of the template version to delete
• force boolean query optional
  When true, allows deletion of the final remaining template version

Responses

Finalizes the second step of the two-phase template version publish workflow. After initiating a publish with PostPublishTemplateVersion and uploading the template archive (.tar.gz) to the pre-signed URL, call this endpoint with the operationID to complete the publish. The service validates that the archive was uploaded successfully before making the version available in the registry. Once complete, the template becomes available to the publisher’s organization. Returns 201 Created on success, 400 for invalid operation state, 404 if the publish operation is not found, or 409 if the version already exists.

Request Parameters

• source string path required
  The template source: ‘private’, ‘github’, or ‘gitlab’
• publisher string path required
  Organization that owns the template
• name string path required
  The template name
• version string path required
  Semantic version string of the template version to complete

Request Body

• operationID string required
  The identifier of the publish operation to complete.

Responses