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

The ChefIngester API from Chef Software — 6 operation(s) for chefingester.

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

This API exposes 6 operations across 6 paths, and defines 19 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.

6 operations 6 paths 19 schemas 1 GET5 POST

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 6

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

ChefIngester 6
POST
/api/v0/ingest/events/chef/action
ChefIngester_ProcessChefAction 1 param → 200default
POST
/api/v0/ingest/events/chef/liveness
ChefIngester_ProcessLivenessPing 1 param → 200default
POST
/api/v0/ingest/events/chef/node-multiple-deletes
ChefIngester_ProcessMultipleNodeDeletes 1 param → 200default
POST
/api/v0/ingest/events/chef/nodedelete
ChefIngester_ProcessNodeDelete 1 param → 200default
POST
/api/v0/ingest/events/chef/run
ChefIngester_ProcessChefRun 1 param → 200default
GET
/api/v0/ingest/version
ChefIngester_GetVersion → 200default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.ingest.request.Run (24 properties), chef.automate.api.ingest.request.Action (21 properties), chef.automate.api.ingest.request.Resource (15 properties), chef.automate.api.ingest.request.Liveness (7 properties). Each schema is shown below with its type and property counts.

chef.automate.api.ingest.request.Description
object
2 properties
chef.automate.api.ingest.request.Run
object
24 properties
google.protobuf.Any
object
2 properties
chef.automate.api.ingest.request.Action
object
21 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.ingest.request.RunList
object
5 properties
chef.automate.api.ingest.response.ProcessChefActionResponse
object
chef.automate.api.ingest.request.MultipleNodeDeleteRequest
object
1 property
chef.automate.api.ingest.response.ProcessMultipleNodeDeleteResponse
object
chef.automate.api.common.version.VersionInfo
object
4 properties
chef.automate.api.ingest.request.Liveness
object
7 properties
chef.automate.api.ingest.response.ProcessLivenessResponse
object
chef.automate.api.ingest.response.ProcessNodeDeleteResponse
object
chef.automate.api.ingest.response.ProcessChefRunResponse
object
chef.automate.api.ingest.request.Delete
object
6 properties
chef.automate.api.ingest.request.Error
object
4 properties
chef.automate.api.ingest.request.Resource
object
15 properties
chef.automate.api.ingest.request.ExpandedRunList
object
2 properties
chef.automate.api.ingest.request.Deprecation
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-chefingester-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 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
Chef Software JobsService API