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 NodeManagerService API

The NodeManagerService API from Chef Software — 9 operation(s) for nodemanagerservice.

Chef Software NodeManagerService 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 NodeManagerService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 11 operations across 9 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.

11 operations 9 paths 16 schemas 4 DELETE1 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 11

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

NodeManagerService 11
POST
/api/v0/nodemanagers
Create a Node Manager
NodeManagerService_Create 1 param → 200default
GET
/api/v0/nodemanagers/id/{id}
View a Node Manager
NodeManagerService_Read 1 param → 200default
DELETE
/api/v0/nodemanagers/id/{id}
Delete a Node Manager
NodeManagerService_Delete 1 param → 200default
PUT
/api/v0/nodemanagers/id/{id}
Update a Node Manager
NodeManagerService_Update 2 params → 200default
DELETE
/api/v0/nodemanagers/id/{id}/with-node-state/stopped
Delete a Node Manager and Stop Nodes
NodeManagerService_DeleteWithNodeStateStopped 1 param → 200default
DELETE
/api/v0/nodemanagers/id/{id}/with-node-state/terminated
Delete a Node Manager and Terminate Nodes
NodeManagerService_DeleteWithNodeStateTerminated 1 param → 200default
DELETE
/api/v0/nodemanagers/id/{id}/with-nodes
Delete a Node Manager and Delete Nodes
NodeManagerService_DeleteWithNodes 1 param → 200default
POST
/api/v0/nodemanagers/id/{node_manager_id}/search-fields
Search Node Fields
NodeManagerService_SearchNodeFields 2 params → 200default
POST
/api/v0/nodemanagers/id/{node_manager_id}/search-nodes
Search nodes
NodeManagerService_SearchNodes 2 params → 200default
POST
/api/v0/nodemanagers/rerun/id/{id}
Connect
NodeManagerService_Connect 2 params → 200default
POST
/api/v0/nodemanagers/search
List all Node Managers
NodeManagerService_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.manager.v1.NodeManager (9 properties), chef.automate.api.nodes.manager.v1.Query (5 properties), grpc.gateway.runtime.Error (4 properties), chef.automate.api.nodes.manager.v1.CredentialsByTags (3 properties). Each schema is shown below with its type and property counts.

chef.automate.api.nodes.manager.v1.Id
object
1 property 1 required
chef.automate.api.nodes.manager.v1.FieldQuery
object
3 properties 1 required
chef.automate.api.nodes.manager.v1.Query
object
5 properties 1 required
chef.automate.api.nodes.manager.v1.NodeManager
object
9 properties 4 required
chef.automate.api.nodes.manager.v1.Fields
object
1 property
chef.automate.api.common.query.Kv
object
2 properties
chef.automate.api.nodes.manager.v1.Query.OrderType
string
Sort the results in ascending or descending order.
chef.automate.api.nodes.manager.v1.Ids
object
1 property
chef.automate.api.nodes.manager.v1.ConnectResponse
object
chef.automate.api.nodes.manager.v1.CredentialsByTags
object
3 properties 3 required
chef.automate.api.nodes.manager.v1.NodeManagers
object
2 properties
google.protobuf.Any
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.nodes.manager.v1.Nodes
object
2 properties
chef.automate.api.common.query.Filter
object
3 properties
chef.automate.api.nodes.manager.v1.NodeQuery
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-nodemanagerservice-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