Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chef Nodes API

The Nodes API from Chef — 3 operation(s) for nodes.

Chef Nodes API is one of 14 APIs that Chef publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Nodes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 6 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{automate}/api/v0.

6 operations 3 paths 0 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://chef.example.com/organizations/example
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Chef Nodes API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-token (apiToken). By default, every request must be authenticated.

  • apiToken — API token issued through the Chef Automate UI or admin API.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Nodes 6
GET
/cfgmgmt/nodes
List configuration management nodes
listManagedNodes → 200
GET
/nodes
List nodes
listNodes → 200
POST
/nodes
Create a node
createNode body → 201
GET
/nodes/{nodeName}
Get a node
getNode 1 param → 200
PUT
/nodes/{nodeName}
Update a node
updateNode 1 param body → 200
DELETE
/nodes/{nodeName}
Delete a node
deleteNode 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-nodes-api-openapi.yml Raw ↑

Other APIs Chef publishes across the network.

Chef InSpec
Chef Channels API
Chef Clients API
Chef Cookbooks API
Chef Data Bags API
Chef Environments API
Chef IAM API
Chef Packages API
Chef Profiles API
Chef Reports API
Chef Roles API
Chef Scans API