# Puppet Forge

> Look things up on the Puppet Forge, the public repository of Puppet modules, no account needed: search modules by owner, endorsement, operating system or Puppet version, read a module or one release (its dependencies, supported systems, Bolt tasks and plans, malware scan and download link), list releases and publishers, and start a workflow when a module you follow publishes a new version.

App · 7 actions. Web page: https://docs.lodol.com/docs/integrations/puppet-forge

## Actions

### Get a module

Read a Puppet module: its summary, endorsement, downloads and rating, its latest version and when it came out, the operating systems and Puppet versions it supports, the modules it needs, its Bolt tasks and plans, every version, its links, and whether it is deprecated and what replaces it.

**Inputs**

- Module (`module`, text, required): The module, owner-name like puppetlabs-stdlib, or a link to its page on forge.puppet.com. Search modules finds it.

**Outputs**

- `contributions_requested` (true/false): True when its owner has asked for help keeping it up.
- `created_at` (text): When it was first published, as an ISO 8601 UTC instant.
- `dependencies` (list): The modules its latest version needs.
- `deprecated` (true/false): True when its owner has deprecated it.
- `deprecated_at` (text): When it was deprecated, as an ISO 8601 UTC instant.
- `deprecation_reason` (text): Why its owner deprecated it.
- `download_url` (text): The link that downloads the release's .tar.gz file from the Forge.
- `downloads` (number): How many times it has been downloaded, all versions.
- `endorsement` (text): How Puppet vouches for it: supported (by Puppet), partner (supported by a Puppet partner), approved or validated. Empty for most modules.
- `feedback_score` (number): Its users' rating out of 100, when it has one.
- `file_sha256` (text): The SHA-256 checksum of its latest version's file.
- `forge_url` (text): Its page on forge.puppet.com.
- `homepage_url` (text): Its home page.
- `issues_url` (text): Where to report a problem with it.
- `latest_released_at` (text): When its latest version came out, as an ISO 8601 UTC instant.
- `latest_version` (text): Its latest version, e.g. 10.1.1.
- `license` (text): Its licence, e.g. Apache-2.0.
- `name` (text): The module's short name, e.g. stdlib.
- `operating_system_support` (list): The operating systems its latest version supports, with their versions.
- `operating_systems` (list): The operating systems its latest version says it supports.
- `owner` (text): The Forge user who publishes it, e.g. puppetlabs.
- `plans` (list): The Bolt plans its latest version ships, by name.
- `premium` (true/false): True for a premium module, which needs paying for.
- `puppet_requirement` (text): The Puppet versions it says it works with, e.g. >= 8.0.0 < 10.0.0.
- `requirements` (list): What its latest version needs installed, such as Puppet.
- `slug` (text): The module's full name, owner-name, e.g. puppetlabs-stdlib: what a Puppetfile and the other steps take.
- `source_url` (text): Its source code repository.
- `summary` (text): What it does, in its author's words.
- `superseded_by` (text): The module to use instead, owner-name, when it is deprecated in favour of another.
- `tags` (list): The words its owner tagged it with.
- `tasks` (list): The Bolt tasks its latest version ships, by name.
- `updated_at` (text): When it last changed on the Forge, as an ISO 8601 UTC instant.
- `version_count` (number): How many versions it has, not counting deleted ones.
- `versions` (list): Every version published and not deleted, newest first.

**Example output**

```json
{
  "contributions_requested": false,
  "created_at": "2011-05-25T01:34:58Z",
  "dependencies": [],
  "deprecated": false,
  "deprecated_at": null,
  "deprecation_reason": null,
  "download_url": "https://forgeapi.puppet.com/v3/files/puppetlabs-stdlib-10.1.1.tar.gz",
  "downloads": 120653036,
  "endorsement": "supported",
  "feedback_score": 98,
  "file_sha256": "073039ceb1eef6925977aad47efb961aa73fbb9710458d2c47f535bfcede3677",
  "forge_url": "https://forge.puppet.com/modules/puppetlabs/stdlib",
  "homepage_url": "https://github.com/puppetlabs/puppetlabs-stdlib",
  "issues_url": "https://github.com/puppetlabs/puppetlabs-stdlib/issues",
  "latest_released_at": "2026-10-27T11:20:14Z",
  "latest_version": "10.1.1",
  "license": "Apache-2.0",
  "name": "stdlib",
  "operating_system_support": [
    {
      "name": "RedHat",
      "versions": [
        "7",
        "8",
        "9"
      ]
    },
    {
      "name": "Ubuntu",
      "versions": [
        "22.04",
        "24.04"
      ]
    },
    {
      "name": "Windows",
      "versions": [
        "2019",
        "2022"
      ]
    }
  ],
  "operating_systems": [
    "RedHat",
    "Ubuntu",
    "Windows"
  ],
  "owner": "puppetlabs",
  "plans": [],
  "premium": false,
  "puppet_requirement": ">= 8.0.0 < 10.0.0",
  "requirements": [
    {
      "name": "puppet",
      "version_requirement": ">= 8.0.0 < 10.0.0"
    }
  ],
  "slug": "puppetlabs-stdlib",
  "source_url": "https://github.com/puppetlabs/puppetlabs-stdlib",
  "summary": "Standard library of resources for Puppet modules.",
  "superseded_by": null,
  "tags": [
    "puppetlabs",
    "library",
    "stdlib"
  ],
  "tasks": [],
  "updated_at": "2026-10-27T11:20:14Z",
  "version_count": 3,
  "versions": [
    "10.1.1",
    "10.1.0",
    "10.0.2"
  ]
}
```

### Get a release

Read one version of a Puppet module (the latest unless you pick one): when it came out, the modules and Puppet versions it needs, the operating systems it supports, its Bolt tasks and plans, its malware scan and quality score, its download link and checksums, and, if asked, its README and changelog.

**Inputs**

- Module (`module`, text, required): The module, owner-name like puppetlabs-stdlib, or a link to its page on forge.puppet.com. Search modules finds it.
- Version (`version`, text): Which version, picked from the list or typed, such as 10.1.1. Empty for the latest.
- Include the README (`include_readme`, true/false): Also return the README, in Markdown. It can be long; off by default. Default: `false`.
- Include the changelog (`include_changelog`, true/false): Also return the changelog, in Markdown. It can be long; off by default. Default: `false`.

**Outputs**

- `changelog` (text): Its changelog in Markdown, with Include the changelog on.
- `deleted` (true/false): True when its owner has deleted it from the Forge.
- `deleted_reason` (text): Why it was deleted.
- `dependencies` (list): The modules it needs.
- `download_url` (text): The link that downloads the release's .tar.gz file from the Forge.
- `downloads` (number): How many times this version has been downloaded.
- `file_md5` (text): The MD5 checksum of its file.
- `file_sha256` (text): The SHA-256 checksum of its file.
- `file_size` (number): The size of its file, in bytes.
- `forge_url` (text): This version's page on forge.puppet.com.
- `is_latest` (true/false): True when the version shown is the module's latest.
- `issues_url` (text): Where to report a problem with it.
- `latest_version` (text): The module's latest version.
- `license` (text): Its licence, e.g. Apache-2.0.
- `malware_flags` (number): How many of the scan's engines flagged the file as malicious or suspicious. Empty when it was not scanned.
- `malware_scan` (text): What the Forge's virus scan found: clean, flagged, or not scanned.
- `malware_scanned_at` (text): When the file was scanned, as an ISO 8601 UTC instant.
- `module` (text): The module's full name, owner-name, e.g. puppetlabs-stdlib: what a Puppetfile and the other steps take.
- `name` (text): The module's short name, e.g. stdlib.
- `operating_system_support` (list): The operating systems it supports, with their versions.
- `owner` (text): The Forge user who publishes it, e.g. puppetlabs.
- `plans` (list): The Bolt plans it ships, by name.
- `puppet_requirement` (text): The Puppet versions it says it works with, e.g. >= 8.0.0 < 10.0.0.
- `quality_score` (number): The Forge's quality score out of 100. The Forge no longer scores new releases, so it is empty for them.
- `readme` (text): Its README in Markdown, with Include the README on.
- `released_at` (text): When it was published, as an ISO 8601 UTC instant.
- `requirements` (list): What it needs installed, such as Puppet.
- `slug` (text): The release's full name, owner-name-version, e.g. puppetlabs-stdlib-10.1.1.
- `source_url` (text): Its source code repository.
- `summary` (text): What it does, in its author's words.
- `tags` (list): The words its owner tagged it with.
- `tasks` (list): The Bolt tasks it ships.
- `version` (text): The version shown, e.g. 10.1.1.

**Example output**

```json
{
  "changelog": null,
  "deleted": false,
  "deleted_reason": null,
  "dependencies": [
    {
      "module": "puppetlabs-stdlib",
      "version_requirement": ">= 4.13.1 < 11.0.0"
    },
    {
      "module": "puppetlabs-concat",
      "version_requirement": ">= 2.2.1 < 11.0.0"
    }
  ],
  "download_url": "https://forgeapi.puppet.com/v3/files/puppetlabs-apache-13.5.0.tar.gz",
  "downloads": 442,
  "file_md5": "380dbbbbefb7b9f55ca20b895d503d49",
  "file_sha256": "0cfa9222054ab7782e38922307a4c20dbf734b8c3455d8ac4df889229721fc57",
  "file_size": 390025,
  "forge_url": "https://forge.puppet.com/modules/puppetlabs/apache/13.5.0",
  "is_latest": true,
  "issues_url": "https://github.com/puppetlabs/puppetlabs-apache/issues",
  "latest_version": "13.5.0",
  "license": "Apache-2.0",
  "malware_flags": null,
  "malware_scan": "not scanned",
  "malware_scanned_at": null,
  "module": "puppetlabs-apache",
  "name": "apache",
  "operating_system_support": [
    {
      "name": "RedHat",
      "versions": [
        "7",
        "8",
        "9",
        "10"
      ]
    },
    {
      "name": "Ubuntu",
      "versions": [
        "18.04",
        "20.04",
        "22.04"
      ]
    }
  ],
  "owner": "puppetlabs",
  "plans": [],
  "puppet_requirement": ">= 8.0.0 < 10.0.0",
  "quality_score": null,
  "readme": null,
  "released_at": "2026-10-27T10:59:11Z",
  "requirements": [
    {
      "name": "puppet",
      "version_requirement": ">= 8.0.0 < 10.0.0"
    }
  ],
  "slug": "puppetlabs-apache-13.5.0",
  "source_url": "https://github.com/puppetlabs/puppetlabs-apache",
  "summary": "Installs, configures, and manages Apache virtual hosts, web services, and modules.",
  "tags": [
    "apache",
    "web",
    "virtualhost"
  ],
  "tasks": [
    {
      "description": "Allows you to perform apache service functions",
      "name": "apache"
    }
  ],
  "version": "13.5.0"
}
```

### Get a user

Read a Puppet Forge user's profile: the name they go by, how many modules and releases they have published, when they joined and their page listing their modules. Search modules with Owner lists the modules themselves.

**Inputs**

- Username (`username`, text, required): The user's name on the Forge, the part before the hyphen in a module's name, such as puppetlabs.

**Outputs**

- `avatar_url` (text): Their profile picture.
- `display_name` (text): The name they go by, e.g. Puppet or Vox Pupuli.
- `forge_url` (text): Their page on forge.puppet.com, listing their modules.
- `joined_at` (text): When they joined the Forge, as an ISO 8601 UTC instant.
- `module_count` (number): How many modules they publish.
- `release_count` (number): How many releases they have published in all.
- `updated_at` (text): When their account last changed, as an ISO 8601 UTC instant.
- `username` (text): The user's name on the Forge, e.g. puppetlabs.

**Example output**

```json
{
  "avatar_url": "https://www.gravatar.com/avatar/fdd009b7c1ec96e088b389f773e87aec",
  "display_name": "Puppet",
  "forge_url": "https://forge.puppet.com/modules/puppetlabs",
  "joined_at": "2010-05-19T12:46:26Z",
  "module_count": 244,
  "release_count": 3533,
  "updated_at": "2026-09-29T13:49:54Z",
  "username": "puppetlabs"
}
```

### List a module's plans

List the Bolt plans a version of a Puppet module ships (the latest unless you pick one), with what each does, the parameters it takes and their defaults, and the command that runs it.

**Inputs**

- Module (`module`, text, required): The module, owner-name like puppetlabs-stdlib, or a link to its page on forge.puppet.com. Search modules finds it.
- Version (`version`, text): Which version, picked from the list or typed, such as 10.1.1. Empty for the latest.

**Outputs**

- `count` (number): How many plans it ships.
- `forge_url` (text): That version's page on forge.puppet.com.
- `is_latest` (true/false): True when that is the module's latest version.
- `module` (text): The module's full name, owner-name, e.g. puppetlabs-stdlib: what a Puppetfile and the other steps take.
- `plans` (list): The plans, in the module's order.
- `version` (text): The version whose plans these are.

**Example output**

```json
{
  "count": 1,
  "forge_url": "https://forge.puppet.com/modules/puppetlabs/ca_extend/3.5.0",
  "is_latest": true,
  "module": "puppetlabs-ca_extend",
  "plans": [
    {
      "description": null,
      "file": "plans/extend_ca_cert.pp",
      "name": "ca_extend::extend_ca_cert",
      "parameters": [
        {
          "default": null,
          "description": "The target node on which to run the plan. Should be the primary Puppet server",
          "name": "targets",
          "type": "TargetSpec"
        },
        {
          "default": "false",
          "description": "Whether to also regenerate the agent certificate of the primary Puppet server",
          "name": "regen_primary_cert",
          "type": "Any"
        }
      ],
      "private": false,
      "run_command": "bolt plan run ca_extend::extend_ca_cert",
      "summary": "Plan that extends the Puppet CA certificate and configures the primary Puppet server and Compilers to use the extended certificate."
    }
  ],
  "version": "3.5.0"
}
```

### List releases

List the versions published on the Puppet Forge, newest or most downloaded first: of one module, of every module one owner publishes, or of the whole Forge. Each comes with its summary, release date, downloads, the Puppet versions it needs and its download link. Deleted releases are left out unless asked for.

**Inputs**

- Module (`module`, text): Only this module's releases, owner-name like puppetlabs-stdlib. Leave empty for every module's.
- Owner (`owner`, text): Only releases of modules published by this Forge user, such as puppetlabs.
- Order (`sort`, text): Newest first by default. One of: `release_date` (Newest first), `downloads` (Most downloaded first), `module` (By module, A to Z). Default: `release_date`.
- Include deleted releases (`include_deleted`, true/false): Also list releases their owners deleted, with why. Off by default. Default: `false`.
- Number of releases (`limit`, number): How many to return, 1 to 100. 20 by default. From 1 to 100. Default: `20`.
- Skip (`offset`, number): How many to skip, to get the next page: use next_offset from the last one. At least 0. Default: `0`.

**Outputs**

- `count` (number): How many are in this page.
- `has_more` (true/false): True when more follow on the next page.
- `next_offset` (number): The Skip value that gets the next page. Empty on the last page.
- `releases` (list): The releases in this page.
- `total_count` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "releases": [
    {
      "deleted": false,
      "deleted_reason": null,
      "download_url": "https://forgeapi.puppet.com/v3/files/puppetlabs-stdlib-10.1.1.tar.gz",
      "downloads": 1104,
      "file_size": 162333,
      "forge_url": "https://forge.puppet.com/modules/puppetlabs/stdlib/10.1.1",
      "module": "puppetlabs-stdlib",
      "puppet_requirement": ">= 8.0.0 < 10.0.0",
      "released_at": "2026-10-27T11:20:14Z",
      "slug": "puppetlabs-stdlib-10.1.1",
      "summary": "Standard library of resources for Puppet modules.",
      "version": "10.1.1"
    }
  ],
  "total_count": 94
}
```

### List users

List the people and organisations who publish modules on the Puppet Forge, most downloaded first or by number of releases, latest release or name, with how many modules and releases each has.

**Inputs**

- Order (`sort`, text): Most downloaded modules first by default. One of: `downloads` (Most downloaded modules first), `releases` (Most releases first), `latest_release` (Most recently released first), `username` (By username, A to Z). Default: `downloads`.
- Number of users (`limit`, number): How many to return, 1 to 100. 20 by default. From 1 to 100. Default: `20`.
- Skip (`offset`, number): How many to skip, to get the next page: use next_offset from the last one. At least 0. Default: `0`.

**Outputs**

- `count` (number): How many are in this page.
- `has_more` (true/false): True when more follow on the next page.
- `next_offset` (number): The Skip value that gets the next page. Empty on the last page.
- `total_count` (number): How many match in all, across every page.
- `users` (list): The users in this page.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "next_offset": 1,
  "total_count": 19320,
  "users": [
    {
      "avatar_url": "https://www.gravatar.com/avatar/fdd009b7c1ec96e088b389f773e87aec",
      "display_name": "Puppet",
      "forge_url": "https://forge.puppet.com/modules/puppetlabs",
      "joined_at": "2010-05-19T12:46:26Z",
      "module_count": 244,
      "release_count": 3533,
      "updated_at": "2026-09-29T13:49:54Z",
      "username": "puppetlabs"
    }
  ]
}
```

### Search modules

Find Puppet modules on the Forge by words, owner, tag, endorsement, operating system, Puppet version, release date or whether they ship Bolt tasks or plans, best match, most downloaded or most recently released first. Each comes with its latest version, summary, downloads and endorsement. A page at a time.

**Inputs**

- Search for (`query`, text): Words to look for in module names, summaries and tags, such as nginx or mysql. Leave empty to list modules by the other filters.
- Owner (`owner`, text): Only modules published by this Forge user, such as puppetlabs (Puppet) or puppet (Vox Pupuli).
- Tag (`tag`, text): Only modules tagged with this word, such as apache or security.
- Endorsements (`endorsements`, list): Only modules Puppet vouches for in one of these ways. Leave empty for every module. One or more of: `supported` (Supported by Puppet), `partner` (Supported by a Puppet partner), `approved` (Approved by Puppet), `validated` (Validated by Puppet).
- Operating system (`operating_system`, text): Only modules that say they support this operating system. One of: `RedHat` (Red Hat Enterprise Linux), `CentOS`, `Rocky` (Rocky Linux), `AlmaLinux`, `OracleLinux` (Oracle Linux), `Amazon` (Amazon Linux), `Fedora`, `Scientific` (Scientific Linux), `Debian`, `Ubuntu`, and 10 more.
- Operating system version (`operating_system_version`, text): Only modules that support this version of the operating system, such as 22.04 for Ubuntu or 2022 for Windows. Needs Operating system.
- Works with Puppet (`puppet_version`, text): Only modules whose requirements include this Puppet version, such as 8, or a range such as >= 7.0.0 < 9.0.0.
- Released since (`released_since`, date): Only modules with a release on or after this day.
- Has Bolt tasks (`with_tasks`, true/false): Only modules that ship Bolt tasks. Off by default. Default: `false`.
- Has Bolt plans (`with_plans`, true/false): Only modules that ship Bolt plans. Off by default. Default: `false`.
- Include deprecated modules (`include_deprecated`, true/false): Also list modules their owners have deprecated. Off by default. Default: `false`.
- Order (`sort`, text): Best match first when searching for words, most downloaded first otherwise, unless you pick an order. One of: `rank` (Best match (when searching for words)), `downloads` (Most downloaded first), `latest_release` (Most recently released first).
- Number of modules (`limit`, number): How many to return, 1 to 100. 20 by default. From 1 to 100. Default: `20`.
- Skip (`offset`, number): How many to skip, to get the next page: use next_offset from the last one. At least 0. Default: `0`.

**Outputs**

- `count` (number): How many are in this page.
- `has_more` (true/false): True when more follow on the next page.
- `modules` (list): The modules in this page.
- `next_offset` (number): The Skip value that gets the next page. Empty on the last page.
- `query` (text): The words searched for.
- `total_count` (number): How many match in all, across every page.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "modules": [
    {
      "deprecated": false,
      "downloads": 11786048,
      "endorsement": "supported",
      "feedback_score": 83,
      "forge_url": "https://forge.puppet.com/modules/puppetlabs/apache",
      "latest_released_at": "2026-10-27T10:59:11Z",
      "latest_version": "13.5.0",
      "name": "apache",
      "operating_systems": [
        "RedHat",
        "CentOS",
        "Debian",
        "Ubuntu"
      ],
      "owner": "puppetlabs",
      "premium": false,
      "puppet_requirement": ">= 8.0.0 < 10.0.0",
      "slug": "puppetlabs-apache",
      "source_url": "https://github.com/puppetlabs/puppetlabs-apache",
      "summary": "Installs, configures, and manages Apache virtual hosts, web services, and modules.",
      "superseded_by": null
    }
  ],
  "next_offset": 1,
  "query": "apache",
  "total_count": 1325
}
```
