Customizing Chef

Appendix A. Chef API Endpoints and Verbs

Full documentation for the Chef Server API can be found at the Chef Documents site, but I’ve included a list of supported endpoints and verbs here for reference (Table A-1).

Table A-1. Chef server API quick reference

Endpoint	GET	PUT	POST	DELETE
/clients	√	X	√	X
/clients/NAME	√	√	X	√
/cookbooks	√	X	X	X
/cookbooks/NAME	√	X	X	X
/cookbooks/NAME/version	√	√	X	√
/data	√	X	√	X
/data/NAME	√	X	√	X
/data/NAME/ITEM	√	√	X	√
/environments	√	X	√	√
/environments/NAME	√	√	X	√
/environments/NAME/cookbooks/NAME	√	X	X	X
/environments/NAME/cookbook_versions	X	X	√	X
/environments/NAME/cookbooks	√	X	X	X
/environments/NAME/nodes	√	X	X	X
/environments/NAME/recipes	√	X	X	X
/environments/NAME/roles/NAME	√	X	X	X
/nodes	√	X	√	√
/nodes/NAME	√	√	X	√
/principals/NAME	√	X	X	X
/roles	√	X	√	X
/roles/NAME	√	√	X	√
/roles/NAME/environments	√	X	X	X
/roles/NAME/environments/NAME	√	X	X	X
/sandboxes	√	X	X	X
/sandboxes/ID	X	√	X	X
/search	√	X	X	X
/search/INDEX	√	X	√	X
/_status	√	X	X	X
/users	√	√	√	√