PuppetDB 3.1 » API » Overview
Included in Puppet Enterprise 2015.2. A newer version is available; see the version menu above for details.
Since PuppetDB collects lots of data from Puppet, it’s an ideal platform for new tools and applications that use that data. You can use the HTTP API described in these pages to interact with PuppetDB’s data.
PuppetDB’s API uses a Command/Query Responsibility Separation (CQRS) pattern. This means:
- Data can be queried using a standard REST-style API. Queries are processed immediately.
- When making changes to data (facts, catalogs, etc), you must send an explicit command (as opposed to submitting data without comment and letting the receiver determine intent). Commands are processed asynchronously in FIFO order.
The PuppetDB API consists of the following parts:
- The REST interface for queries
- The HTTP command submission interface
- The wire formats that PuppetDB requires for incoming data
PuppetDB’s data can be queried with a REST API.
The available query endpoints are documented in the pages linked below.
This is the current stable API.
- Nodes Endpoint
- Environments Endpoint
- Factsets Endpoint
- Facts Endpoint
- Fact-Names Endpoint
- Fact-Paths Endpoint
- Fact-Contents Endpoint
- Catalogs Endpoint
- Edges Endpoint
- Resources Endpoint
- Reports Endpoint
- Events Endpoint
- Event Counts Endpoint
- Aggregate Event Counts Endpoint
- Metrics Endpoint
- Server Time Endpoint
- Version Endpoint
Version 3 (Retired)
Version 3 of the query API has been retired. Please use v4.
Version 2 (Retired)
Version 2 of the query API has been retired. Please use v4.
Commands are sent via HTTP but do not use a REST-style interface.
PuppetDB supports a relatively small number of commands. The command submission interface and the available commands are all described at the commands page:
Unlike the query API, these commands are generally only useful to Puppet itself, and all format conversion and command submission is handled by the PuppetDB termini on your Puppet master.
The “replace” commands all require data in one of the wire formats described below.
All of PuppetDB’s “replace” commands contain payload data, which must be in one of the following formats. These formats are also linked from the commands that use them.