How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chef Software ConfigMgmt API

The ConfigMgmt API from Chef Software — 23 operation(s) for configmgmt.

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

This API exposes 23 operations across 23 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version version not set.

Requests are made against a single base URL, https://automate.chef.io/api/v0.

23 operations 23 paths 42 schemas 20 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
version not set
Base URL
https://automate.chef.io/api/v0
Resource Areas
1

Paths & Operations 23

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

ConfigMgmt 23
POST
/api/beta/cfgmgmt/rollouts/create
CreateRollout
ConfigMgmt_CreateRollout body → 200default
GET
/api/beta/cfgmgmt/rollouts/find
GetRolloutForChefRun
ConfigMgmt_GetRolloutForChefRun 3 params → 200default
GET
/api/beta/cfgmgmt/rollouts/list
GetRollouts
ConfigMgmt_GetRollouts 1 param → 200default
GET
/api/beta/cfgmgmt/rollouts/progress_by_node_segment
ConfigMgmt_ListNodeSegmentsWithRolloutProgress 1 param → 200default
GET
/api/beta/cfgmgmt/rollouts/rollout/{rollout_id}
GetRolloutById
ConfigMgmt_GetRolloutById 1 param → 200default
POST
/api/beta/cfgmgmt/rollouts/test_create
CreateRolloutTest
ConfigMgmt_CreateRolloutTest body → 200default
GET
/api/v0/cfgmgmt/errors
List Errors
ConfigMgmt_GetErrors 2 params → 200default
GET
/api/v0/cfgmgmt/node_metadata_counts
GetNodeMetadataCounts
ConfigMgmt_GetNodeMetadataCounts 4 params → 200default
GET
/api/v0/cfgmgmt/node_runs_daily_status_time_series
GetNodeRunsDailyStatusTimeSeries
ConfigMgmt_GetNodeRunsDailyStatusTimeSeries 2 params → 200default
GET
/api/v0/cfgmgmt/nodes
List Checked-in Nodes
ConfigMgmt_GetNodes 7 params → 200default
GET
/api/v0/cfgmgmt/nodes/{node_id}/attribute
Show Attributes
ConfigMgmt_GetAttributes 1 param → 200default
GET
/api/v0/cfgmgmt/nodes/{node_id}/runs
List Run Details
ConfigMgmt_GetRuns 6 params → 200default
GET
/api/v0/cfgmgmt/nodes/{node_id}/runs/{run_id}
Show Node Run
ConfigMgmt_GetNodeRun 3 params → 200default
GET
/api/v0/cfgmgmt/organizations
List Organizations
ConfigMgmt_GetOrganizations → 200default
GET
/api/v0/cfgmgmt/policy_revision/{revision_id}
List Policy Cookbooks
ConfigMgmt_GetPolicyCookbooks 1 param → 200default
GET
/api/v0/cfgmgmt/source_fqdns
List Associated Chef Infra Servers
ConfigMgmt_GetSourceFqdns → 200default
GET
/api/v0/cfgmgmt/stats/checkin_counts_timeseries
List Node Checkins
ConfigMgmt_GetCheckInCountsTimeSeries 2 params → 200default
GET
/api/v0/cfgmgmt/stats/missing_node_duration_counts
List Missing Nodes Count
ConfigMgmt_GetMissingNodeDurationCounts 1 param → 200default
GET
/api/v0/cfgmgmt/stats/node_counts
List Node Status Counts
ConfigMgmt_GetNodesCounts 3 params → 200default
GET
/api/v0/cfgmgmt/stats/run_counts
List Run Status Totals
ConfigMgmt_GetRunsCounts 4 params → 200default
GET
/api/v0/cfgmgmt/suggestions
List Filter Suggestions
ConfigMgmt_GetSuggestions 3 params → 200default
GET
/api/v0/cfgmgmt/telemetry/nodes/count
GetNodesUsageCount
ConfigMgmt_GetNodesUsageCount → 200default
PUT
/api/v0/cfgmgmt/telemetry/nodes/count/updated
UpdateTelemetryReported Acknowledge API to updates the last client run telemetry reported date in postgres Authorization Action: iam:introspect:getAll
ConfigMgmt_UpdateTelemetryReported body → 200default

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.cfgmgmt.response.Run (48 properties), chef.automate.api.cfgmgmt.response.Rollout (18 properties), chef.automate.api.cfgmgmt.request.CreateRollout (15 properties), chef.automate.api.cfgmgmt.response.Resource (13 properties). Each schema is shown below with its type and property counts.

chef.automate.api.cfgmgmt.response.ErrorCount
object
3 properties
chef.automate.api.cfgmgmt.response.Errors
object
Errors contains a list of the most common Chef Infra error type/message combinations among nodes in the active project as filtered according to the request.
1 property
chef.automate.api.cfgmgmt.response.NodeSegmentsWithRolloutProgress
object
A Node Segment is the set of Chef Infra nodes with a shared policyname, policynodegroup, and policydomainurl. NodeSegmentsWithRolloutProgress lists all of the…
1 property
chef.automate.api.cfgmgmt.response.CountedDuration
object
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.cfgmgmt.response.NodeSegmentRolloutProgress
object
6 properties
chef.automate.api.cfgmgmt.response.SCMWebType
string
chef.automate.api.cfgmgmt.response.NodesCounts
object
4 properties
chef.automate.api.cfgmgmt.response.UpdateTelemetryReportedResponse
object
chef.automate.api.cfgmgmt.response.SCMType
string
chef.automate.api.cfgmgmt.request.CreateRollout
object
CreateRollout is a request to create a new Rollout. All fields have the same meaning as with the response Rollout type.
15 properties
chef.automate.api.cfgmgmt.response.CreateRolloutTest
object
chef.automate.api.cfgmgmt.response.PastRolloutProgress
object
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.cfgmgmt.response.CurrentRolloutProgress
object
6 properties
chef.automate.api.cfgmgmt.response.PolicyCookbooks
object
2 properties
chef.automate.api.cfgmgmt.request.UpdateTelemetryReportedRequest
object
1 property
chef.automate.api.cfgmgmt.response.TypeCount
object
2 properties
chef.automate.api.cfgmgmt.response.RunsCounts
object
3 properties
chef.automate.api.cfgmgmt.response.ValueCount
object
2 properties
chef.automate.api.cfgmgmt.response.CookbookLock
object
2 properties
chef.automate.api.cfgmgmt.response.Rollout
object
A Rollout represents the process of distributing Chef Infra code (with Policyfiles) to a set of nodes. It's used to track which nodes have run the latest versi…
18 properties
chef.automate.api.cfgmgmt.response.CheckInCounts
object
4 properties
chef.automate.api.cfgmgmt.response.RunList
object
5 properties
chef.automate.api.cfgmgmt.response.Run
object
48 properties
chef.automate.api.cfgmgmt.response.NodeAttribute
object
13 properties
chef.automate.api.cfgmgmt.response.MissingNodeDurationCounts
object
1 property
chef.automate.api.cfgmgmt.response.RunDurationStatus
object
4 properties
chef.automate.api.cfgmgmt.request.CreateRolloutTest
object
chef.automate.api.cfgmgmt.response.VersionedCookbook
object
2 properties
chef.automate.api.cfgmgmt.response.Deprecation
object
3 properties
chef.automate.api.cfgmgmt.request.SCMWebType
string
chef.automate.api.cfgmgmt.request.SCMType
string
chef.automate.api.cfgmgmt.response.Description
object
2 properties
chef.automate.api.cfgmgmt.response.ExpandedRunList
object
2 properties
chef.automate.api.cfgmgmt.response.NodeMetadataCounts
object
1 property
chef.automate.api.cfgmgmt.response.ChefError
object
4 properties
chef.automate.api.cfgmgmt.response.Resource
object
13 properties
chef.automate.api.cfgmgmt.response.NodeRunsDailyStatusTimeSeries
object
1 property
chef.automate.api.cfgmgmt.response.Rollouts
object
1 property
chef.automate.api.cfgmgmt.response.GetNodesUsageCountResponse
object
2 properties
chef.automate.api.cfgmgmt.response.CheckInCountsTimeSeries
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-configmgmt-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 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
Where this information came from

This is an independent, third-party profile of Chef Software ConfigMgmt API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.