Registry

GetPackageNav

Returns the package navigation: a flat list of modules in schema-declaration order. By default returns a summary (module names and counts only) suitable for discovery. Pass 'depth=full' to include resources and functions; combine with 'q' to filter results by name or type token. Module names like 's3/bucket' are flat strings, not nested. Supports JSON or markdown via Accept. Returns 404 if the package version does not exist.

get/api/registry/packages/{source}/{publisher}/{name}/versions/{version}/nav

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/packages/{source}/{publisher}/{name}/versions/{version}/nav
  • 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'

Query parameters

depthstring

'summary' (default) returns module names and counts only; 'full' includes resources and functions.

lang'typescript' | 'python' | 'go' | 'csharp' | 'java' | 'yaml' | 'hcl' | 'all'

Language for name resolution. Defaults to 'go', which is also what 'all' resolves to here.

qstring

Case-insensitive substring filter on resource/function names and type tokens. Modules with no matches are omitted. Combine with 'depth=full' to return matched items.

Response

OK

descriptionstring

Short description of the package.

docsUrlTemplatestring required

URL template for the docs endpoint. Substitute '{typeToken}' with a URL-encoded Pulumi type token from a navigation item.

installationUrlstring

Path to the installation configuration endpoint, if present.

languagestring

Rendering target for resolved names. Individual content may fall back to another available language when the target is missing.

modulesTotalinteger required

Total number of modules in the package, independent of 'q'.

namestring required

Package name (e.g. 'aws').

packageVersionUrlstring required

Path to the package version metadata endpoint.

publisherstring required

Package publisher (e.g. 'pulumi').

readmeUrlstring required

Path to the README endpoint.

sourcestring required

Package source (e.g. 'pulumi').

titlestring required

Display title.

versionstring required

Resolved semantic version.

Changes

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