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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Chef Software

Chef Software ReportingService API

The ReportingService API from Chef Software — 12 operation(s) for reportingservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

12 operations 12 paths 47 schemas 1 GET11 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 12

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

ReportingService 12
POST
/api/v0/compliance/reporting/controls
List Controls
ReportingService_ListControlItems 1 param → 200default
POST
/api/v0/compliance/reporting/controls/search
List Controls Search
ReportingService_ListControlItemsRange 1 param → 200default
POST
/api/v0/compliance/reporting/nodeheader/id/{id}
Show Node Header Info From Report ID
ReportingService_ReadNodeHeader 2 params → 200default
GET
/api/v0/compliance/reporting/nodes/id/{id}
Show Node by ID
ReportingService_ReadNode 1 param → 200default
POST
/api/v0/compliance/reporting/nodes/search
List Nodes
ReportingService_ListNodes 1 param → 200default
POST
/api/v0/compliance/reporting/profiles
List Profiles
ReportingService_ListProfiles 1 param → 200default
POST
/api/v0/compliance/reporting/report-ids
List Report IDs
ReportingService_ListReportIds 1 param → 200default
POST
/api/v0/compliance/reporting/reportcontrols/id/{id}
List Control Info
ReportingService_ListControlInfo 2 params → 200default
POST
/api/v0/compliance/reporting/reportmanager/export
Export reports
ReportingService_ExportReportManager 1 param → 200default
POST
/api/v0/compliance/reporting/reports
List Reports
ReportingService_ListReports 1 param → 200default
POST
/api/v0/compliance/reporting/reports/id/{id}
Show Report by ID
ReportingService_ReadReport 2 params → 200default
POST
/api/v0/compliance/reporting/suggestions
List Reporting Suggestions
ReportingService_ListSuggestions 1 param → 200default

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.compliance.reporting.v1.Profile (20 properties), chef.automate.api.compliance.reporting.v1.Report (20 properties), chef.automate.api.compliance.reporting.v1.Dependency (13 properties), chef.automate.api.compliance.reporting.v1.Control (12 properties). Each schema is shown below with its type and property counts.

chef.automate.api.compliance.reporting.v1.SourceLocation
object
2 properties
chef.automate.api.compliance.reporting.v1.ControlItemRequest
object
4 properties
chef.automate.api.compliance.reporting.v1.ProfileCounts
object
Stats on the statuses of nodes matching the filters.
5 properties
chef.automate.api.compliance.reporting.v1.Kv
object
2 properties
chef.automate.api.compliance.reporting.v1.Total
object
A subtotal of controls.
1 property
chef.automate.api.compliance.reporting.v1.Attribute
object
2 properties
chef.automate.api.compliance.reporting.v1.Failed
object
Stats of failed controls.
4 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.v1.ControlSummary
object
A minimal representation of the statuses of the controls in the report.
5 properties
chef.automate.api.compliance.reporting.v1.RemovedResultsCounts
object
3 properties
chef.automate.api.compliance.reporting.v1.ListFilter
object
2 properties
chef.automate.api.compliance.reporting.v1.Group
object
3 properties
chef.automate.api.compliance.reporting.v1.ProfileMins
object
2 properties
chef.automate.api.compliance.reporting.v1.Suggestions
object
1 property
chef.automate.api.compliance.reporting.v1.OrigWaiverData
object
5 properties
chef.automate.api.compliance.reporting.v1.Statistics
object
Statistics of the report's run.
1 property
chef.automate.api.compliance.reporting.v1.ProfileMin
object
Minimal representation of a profile.
5 properties
chef.automate.api.compliance.reporting.v1.NodeHeaderProfileInfo
object
3 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.compliance.reporting.v1.Control
object
12 properties
chef.automate.api.compliance.reporting.v1.Query.OrderType
string
Sort the results in ascending or descending order.
chef.automate.api.compliance.reporting.v1.ControlElements
object
1 property
chef.automate.api.compliance.reporting.v1.ControlElement
object
7 properties
chef.automate.api.compliance.reporting.v1.Ref
object
2 properties
chef.automate.api.compliance.reporting.v1.ReportIds
object
2 properties
chef.automate.api.compliance.reporting.v1.ProfileMeta
object
5 properties
chef.automate.api.compliance.reporting.v1.Result
object
6 properties
chef.automate.api.compliance.reporting.v1.WaiverData
object
4 properties
chef.automate.api.compliance.reporting.v1.NodeHeaderInfo
object
10 properties
chef.automate.api.compliance.reporting.v1.ReportsSummaryLevelOne
object
2 properties
chef.automate.api.compliance.reporting.v1.ControlItems
object
2 properties
chef.automate.api.compliance.reporting.v1.ReportData
object
2 properties
chef.automate.api.compliance.reporting.v1.ControlItem
object
7 properties
chef.automate.api.compliance.reporting.v1.Node
object
7 properties
chef.automate.api.compliance.reporting.v1.Platform
object
The name and version of the node's operating system.
3 properties
chef.automate.api.compliance.reporting.v1.SuggestionRequest
object
5 properties
chef.automate.api.compliance.reporting.v1.CustomReportResponse
object
1 property
chef.automate.api.compliance.reporting.v1.LatestReportSummary
object
A summary of the latest report for this node.
4 properties
chef.automate.api.compliance.reporting.v1.Report
object
20 properties
chef.automate.api.compliance.reporting.v1.Support
object
5 properties
chef.automate.api.compliance.reporting.v1.Option
object
2 properties
chef.automate.api.compliance.reporting.v1.Query
object
7 properties
chef.automate.api.compliance.reporting.v1.Suggestion
object
4 properties
chef.automate.api.compliance.reporting.v1.ReportSummaryLevelOne
object
7 properties
chef.automate.api.compliance.reporting.v1.Nodes
object
6 properties
chef.automate.api.compliance.reporting.v1.Profile
object
20 properties
chef.automate.api.compliance.reporting.v1.Dependency
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Chef Software publishes across the network.

Chef Software ApplicationsService API
AE Profile APIs.io
Chef Software Authorization API
AE Profile APIs.io
Chef Software Cds API
AE Profile APIs.io
Chef Software ChefIngester API
AE Profile APIs.io
Chef Software Comp_Assets API
AE Profile APIs.io
Chef Software ConfigMgmt API
AE Profile APIs.io
Chef Software DatafeedService API
AE Profile APIs.io
Chef Software DataLifecycle API
AE Profile APIs.io
Chef Software EventFeedService API
AE Profile APIs.io
Chef Software hidden API
AE Profile APIs.io
Chef Software InfraProxy API
AE Profile APIs.io
Chef Software JobScheduler API
AE Profile APIs.io
#ReportingService
← Back to C APIs
API Details
ID
chef-software:chef-software-reportingservice-api
Base URL
https://automate.chef.io/api/v0
Docs
https://docs.chef.io/automate/api/
Provider
Chef Software
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network