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 Software NodesService API

The NodesService API from Chef Software — 7 operation(s) for nodesservice.

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

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

This API exposes 9 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version version not set.

Requests are made against the base URL https://automate.chef.io/api/v0.

9 operations 7 paths 16 schemas 1 DELETE2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
version not set
Base URL
https://automate.chef.io/api/v0
Resource Areas
1

Paths & Operations 9

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

NodesService 9
POST
/api/v0/nodes
Create a Node
NodesService_Create 1 param → 200default
POST
/api/v0/nodes/bulk-create
Bulk Create Nodes
NodesService_BulkCreate 1 param → 200default
POST
/api/v0/nodes/delete
Bulk Delete Nodes by Filter
NodesService_BulkDelete 1 param → 200default
POST
/api/v0/nodes/delete/ids
Bulk Delete Nodes by ID
NodesService_BulkDeleteById 1 param → 200default
GET
/api/v0/nodes/id/{id}
Show Node Details
NodesService_Read 1 param → 200default
DELETE
/api/v0/nodes/id/{id}
Delete a Node
NodesService_Delete 1 param → 200default
PUT
/api/v0/nodes/id/{id}
Update Node
NodesService_Update 2 params → 200default
GET
/api/v0/nodes/rerun/id/{id}
List Node Status
NodesService_Rerun 1 param → 200default
POST
/api/v0/nodes/search
List and Filter Nodes
NodesService_List 1 param → 200default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.nodes.v1.Node (17 properties), chef.automate.api.nodes.v1.TargetConfig (10 properties), chef.automate.api.nodes.v1.ResultsRow (7 properties), chef.automate.api.nodes.v1.Query (5 properties). Each schema is shown below with its type and property counts.

chef.automate.api.nodes.v1.TargetConfig
object
Details for ssh/winrm access of the node.
10 properties
chef.automate.api.nodes.v1.Query.OrderType
string
Return the results in ascending or descending order.
chef.automate.api.nodes.v1.LastContactData
object
Most recent node data from the latest Chef Infra run and InSpec scan.
4 properties
chef.automate.api.nodes.v1.ResultsRow
object
Summary of the last Chef InSpec scan job run on the node.
7 properties
chef.automate.api.common.query.Kv
object
2 properties
chef.automate.api.nodes.v1.Id
object
1 property
chef.automate.api.nodes.v1.Query
object
5 properties
chef.automate.api.nodes.v1.Ids
object
1 property
chef.automate.api.nodes.v1.LastContactData.Status
string
chef.automate.api.nodes.v1.BulkDeleteResponse
object
1 property
google.protobuf.Any
object
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.nodes.v1.Node
object
Node information.
17 properties
chef.automate.api.common.query.Filter
object
3 properties
chef.automate.api.nodes.v1.RerunResponse
object
chef.automate.api.nodes.v1.Nodes
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-nodesservice-api-openapi.yml Raw ↑

Other APIs Chef Software publishes across the network.

Chef Software ApplicationsService API
Chef Software Authorization API
Chef Software Cds API
Chef Software ChefIngester API
Chef Software Comp_Assets API
Chef Software ConfigMgmt API
Chef Software DatafeedService API
Chef Software DataLifecycle API
Chef Software EventFeedService API
Chef Software hidden API
Chef Software InfraProxy API
Chef Software JobScheduler API