Private registry API overview

Use the /private-registry API to publish and manage modules, providers, and Stack component configurations in your private registry. The available endpoints are organized by artifact type.

Modules

Call the /registry-modules endpoints to list, create, publish, update, and delete modules in your organization's private registry. You can also manage module versions, run tests against published modules, and configure dynamic credentials for test runs. Refer to the following topics for reference and usage information:

• Registry modules API reference: List, create, publish, update, and delete registry modules.
• Manage module versions API reference: Deprecate, revoke, and revert the status of module versions.
• Tests API reference: Create and list test runs for a registry module.
• Test configuration API: Configure dynamic credential workload identity for module test runs.

Providers

Call the /registry-providers endpoints to list, create, and delete providers in your organization's private registry. You can also manage provider versions and platforms, update version tags, and add GPG keys used to verify provider packages. Refer to the following topics for reference and usage information:

• Registry providers API reference: List, create, get, and delete registry providers.
• Private provider versions and platforms API reference: Create, list, and delete provider versions and their platforms.
• Manage provider versions API reference: List, add, and update tags for provider versions.
• GPG keys API reference: Add and manage GPG keys used to verify private provider packages.

Stack component configurations

Call the /registry-components endpoints to list, create, publish, update, and delete Stack component configuration versions in your organization's private registry. You can also manage component version tags. Refer to the following topics for reference and usage information:

• Stack component configurations API reference: List, create, publish, update, and delete Stack component configurations.
• Manage component versions API reference: List, add, and update tags for component configuration versions.

Apply tags to registry artifacts in bulk

Call the /bulk-actions endpoints to add, remove, or set tags on registry artifacts in bulk and to check the status of a bulk tagging job. Bulk tagging applies to modules, providers, and Stack component configurations.