API overview

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.

• Specification of the general query structure

• AST query language

• Puppet query language

• Query tutorial

• Curl tips

The available query endpoints are documented in the pages linked below.

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 all available commands are 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 Server.

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.

• Facts wire format version 4

• Catalog wire format version 6

• Report wire format version 5