Node classifier API v1
These are the endpoints for the node classifier v1 API.
-
Forming node classifier API requests
Requests to the node classifier API must be well-formed HTTP(S) requests.
-
The
groups
endpoints create, read, update, and delete groups. -
Use the
classes
endpoint to retrieve a list of all classes. -
The
classification
endpoints accepts a node name and a set of facts, and then return information about how the specified node is classified. The output can help you test your node group classification rules. -
Use the
commands
endpoint to unpin specified nodes from all node groups they’re pinned to. -
Use the
environments
endpoints to retrieve the node classifier's environment data. The responses tell you which environments are available, whether a named environment exists, and which classes exist in a certain environment. -
Nodes check-in history endpoints
Use the
nodes
endpoints to retrieve records about nodes that have checked into the node classifier. -
Use the
group-children
endpoint to retrieve a list of node groups descending from a specific node group. -
Use the
rules
endpoint to translate a node group rule condition into PuppetDB query syntax. -
Use the
import hierarchy
endpoint to delete all existing node groups from the node classifier service and replace them with the node groups defined in the body of the request. -
Use the
last-class-update
endpoint to retrieve the time that classes were last updated from the primary server. -
Use the
update-classes
endpoint to trigger the node classifier to get updated class and environment definitions from the primary server. -
Use the
validation
endpoint to validate groups in the node classifier. -
Learn about node classifier API error responses.