Rules endpoint

Sections

Use the rules endpoint to translate a group’s rule condition into PuppetDB query syntax.

POST /v1/rules/translate

Translate a group's rule condition into PuppetDB query syntax.

Request format

The request's body should contain a rule condition as it would appear in the rule field of a group object. See the documentation on rule grammar for a complete description of how these conditions can be structured.

The endpoint supports an optional query parameter format, which defaults to nodes. If specified as ?format=inventory, it allows you to get the classifier rules in a compatible dot notation format instead of the standard PuppetDB AST.

Response format

The response is a PuppetDB query string that can be used with PuppetDB nodes endpoint in order to see which nodes would satisfy the rule condition (that is, which nodes would be classified into a group with that rule).

Error responses

Rules that use structured or trusted facts cannot be converted into PuppetDB queries, because PuppetDB does not yet support structured or trusted facts. If the rule cannot be translated into a PuppetDB query, the server returns a 422 Unprocessable Entity response containing the usual JSON error object. The error object has a kind of "untranslatable-rule", a msg that describes why the rule cannot be translated, and contains the received rule in details.

If the request does not contain a valid rule, the server returns a 400 Bad Request response with the usual JSON error object. If the rule was not valid JSON, the error's kind is "malformed-request", the msg states that the request's body could not be parsed as JSON, and the details contain the request's body as received by the server.

If the rule does not conform to the rule grammar, the kind key is "schema-violation, and the details key is an object with submitted, schema, and error keys which respectively describe the submitted object, the schema that object should conform to, and how the submitted object failed to conform to the schema.

How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.