RegistryPreview

GetPackageVersion

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.

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

Path parameters

sourcestring required

The package source: 'pulumi', 'opentofu', or 'private'

publisherstring required

Organization that owns the package

namestring required

The package name

versionstring required

Semantic version string or 'latest'

Response

OK

categorystring

The category of the package.

createdAtstring date-time required

The date and time the package version was created.

descriptionstring

The description of the package.

isFeaturedboolean required

Whether the package is featured.

logoUrlstring

The URL of the logo for the package.

namestring required

The name of the package.

packageStatus'ga' | 'public_preview' required

The maturity level of the package, e.g. "ga", "public_preview"

packageTypesstring[]

The package types, e.g. "native", "component", "bridged"

pluginDownloadURLstring

The URL to download the plugin at, as found in the schema.

publisherstring required

The publisher of the package.

publisherDisplayNamestring

The display name of the publisher.

readmeURLstring required

The URL of the readme for the package.

repoUrlstring

The URL of the repository the package is hosted in.

schemaURLstring required

The URL of the schema for the package.

sourcestring required

The source of the package.

titlestring

The title/display name of the package.

versionstring required

The version of the package in semver format.

visibility'public' | 'private' required

The visibility of the package.

Changes

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