Node classifier API v1
These are the endpoints for the node classifier v1 API.
Tip: In addition to these endpoints,
you can use the status API to check the health of the node classifier service.
-
Forming node classifier API requests
Requests to the node classifier API must be well-formed HTTP(S) requests. -
Groups endpoints
Thegroups
endpoints create, read, update, and delete groups. -
Classes endpoint
Use theclasses
endpoint to retrieve a list of all classes. -
Classification endpoints
Theclassification
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. -
Commands endpoint
Use thecommands
endpoint to unpin specified nodes from all node groups they’re pinned to. -
Environments endpoints
Use theenvironments
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 thenodes
endpoints to retrieve records about nodes that have checked into the node classifier. -
Group children endpoint
Use thegroup-children
endpoint to retrieve a list of node groups descending from a specific node group. -
Rules endpoint
Use therules
endpoint to translate a node group rule condition into PuppetDB query syntax. -
Import hierarchy endpoint
Use theimport 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. -
Last class update endpoint
Use thelast-class-update
endpoint to retrieve the time that classes were last updated from the primary server. -
Update classes endpoint
Use theupdate-classes
endpoint to trigger the node classifier to get updated class and environment definitions from the primary server. -
Validation endpoint
Use thevalidation
endpoint to validate groups in the node classifier. -
Node classifier API errors
Learn about node classifier API error responses.
Related information