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

The StatsService API from Chef Software — 6 operation(s) for statsservice.

Chef Software StatsService 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 StatsService. 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 24 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 24 schemas 1 GET4 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 6

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

StatsService 6
POST
/api/v0/compliance/reporting/stats/failures
Read Failures
StatsService_ReadFailures 1 param → 200default
GET
/api/v0/compliance/reporting/stats/nodes/count
GetNodesUsageCount
StatsService_GetNodesUsageCount → 200default
PUT
/api/v0/compliance/reporting/stats/nodes/count/updated
UpdateTelemetryReported
StatsService_UpdateTelemetryReported 1 param → 200default
POST
/api/v0/compliance/reporting/stats/profiles
Read Profiles
StatsService_ReadProfiles 1 param → 200default
POST
/api/v0/compliance/reporting/stats/summary
Read Summary
StatsService_ReadSummary 1 param → 200default
POST
/api/v0/compliance/reporting/stats/trend
Read Trend
StatsService_ReadTrend 1 param → 200default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.compliance.reporting.v1.Dependency (13 properties), chef.automate.api.compliance.reporting.stats.v1.ProfileSummary (11 properties), chef.automate.api.compliance.reporting.stats.v1.ProfileList (9 properties), chef.automate.api.compliance.reporting.stats.v1.Query (9 properties). Each schema is shown below with its type and property counts.

chef.automate.api.compliance.reporting.stats.v1.Stats
object
General statistics about the reports.
6 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
chef.automate.api.compliance.reporting.stats.v1.ProfileList
object
9 properties
chef.automate.api.compliance.reporting.stats.v1.Trends
object
1 property
chef.automate.api.compliance.reporting.stats.v1.ListFilter
object
2 properties
chef.automate.api.compliance.reporting.stats.v1.Query
object
9 properties
chef.automate.api.compliance.reporting.stats.v1.ReportSummary
object
Statistics on the overall compliance reports.
4 properties
chef.automate.api.compliance.reporting.stats.v1.UpdateTelemetryReportedResponse
object
chef.automate.api.compliance.reporting.stats.v1.ControlsSummary
object
Statistics for the controls executed in the compliance reports.
7 properties
chef.automate.api.compliance.reporting.stats.v1.GetNodesUsageCountResponse
object
2 properties
chef.automate.api.compliance.reporting.stats.v1.Trend
object
5 properties
chef.automate.api.compliance.reporting.stats.v1.Failures
object
4 properties
chef.automate.api.compliance.reporting.stats.v1.Support
object
7 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.compliance.reporting.stats.v1.Query.OrderType
string
Sort the results in ascending or descending order.
chef.automate.api.compliance.reporting.stats.v1.ControlStats
object
7 properties
chef.automate.api.compliance.reporting.stats.v1.ProfileSummary
object
Summary information about a specific profile's execution across the reports.
11 properties
chef.automate.api.compliance.reporting.stats.v1.NodeSummary
object
Statistics about the nodes scanned in the compliance reports.
7 properties
chef.automate.api.compliance.reporting.stats.v1.ProfileSummaryStats
object
Statistics about the nodes that executed the profile.
6 properties
chef.automate.api.compliance.reporting.stats.v1.Profile
object
3 properties
chef.automate.api.compliance.reporting.stats.v1.UpdateTelemetryReportedRequest
object
1 property
chef.automate.api.compliance.reporting.stats.v1.FailureSummary
object
4 properties
chef.automate.api.compliance.reporting.stats.v1.Summary
object
3 properties
chef.automate.api.compliance.reporting.v1.Dependency
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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