Using the Forge API

Use the Forge API to create, delete, and understand your modules.

Create a module release

Use the /v3/releases endpoint in the Forge API to create and publish a new module or a release of an existing module.

Download a module release

Use the /v3/files/{filename} endpoint in the Forge API to download the tarball for an existing module.

Fetch information about a module release

Use the /v3/releases/{release_slug} endpoint in the Forge API to fetch information about your module, identified by the module's slug value.

Delete a module release

Use the /v3/releases/{release_slug} endpoint in the Forge API to soft delete a release of your module, identified by the module's slug value. A deleted release is still downloadable from the /v3/files endpoint, but not available in PuppetForge.

More information about the Forge API

For more detailed information about the Forge API, including parameters, responses, and example code, see the Forge API documentation.