Chef Software service_groups 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 service_groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
9 operations
across 9 paths,
and defines 14 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 operations9 paths14 schemas7 GET2 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 9
Across 9 paths, the API surfaces 9 operations — 7 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.applications.Service (18 properties), chef.automate.api.applications.ServiceGroup (10 properties), chef.automate.api.applications.HealthCounts (6 properties), grpc.gateway.runtime.Error (4 properties). Each schema is shown below with its type and property counts.
chef.automate.api.applications.HealthCounts
object
Combined count values from the health status and disconnected status reports.
6 properties
chef.automate.api.applications.HealthStatus
string
The HealthStatus enumerable matches the Chef Habitat implementation for health-check status: = https://www.habitat.sh/docs/reference/health-check For a health…
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.applications.HealthCheckResult
object
3 properties
chef.automate.api.applications.ServiceGroup
object
A service group message is the representation of an individual service group that is internally generated by aggregating all of its services.
10 properties
chef.automate.api.applications.ServicesBySGRes
object
Response message for GetServicesBySG.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
