# Chef Automate API

**Canonical:** https://apis.io/apis/progress-software/progress-software-chef-automate/  
**Provider:** Progress Software — https://apis.io/providers/progress-software/  
**Base URL:** https://automate.chef.io  
**Documentation:** https://docs.chef.io/automate/api/

Chef Automate API is one of 5 APIs that [Progress Software](https://apis.io/providers/progress-software/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Compliance, Configuration Management, DevOps, and Infrastructure Automation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Chef Automate API is the HTTP surface of Progress Chef Automate, the dashboard and control plane for Chef Infra, Chef InSpec and Chef Habitat. It covers configuration management node and run history, compliance scanning and reporting, IAM (users, teams, tokens, policies, projects), data lifecycle, secrets, notifications, node manager integrations and license management. The published Swagger 2.0 contract carries 277 operations across 215 paths.

## Operations (60 of 277)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/beta/cfgmgmt/rollouts/create` | CreateRollout |
| GET | `/api/beta/cfgmgmt/rollouts/find` | GetRolloutForChefRun |
| GET | `/api/beta/cfgmgmt/rollouts/list` | GetRollouts |
| GET | `/api/beta/cfgmgmt/rollouts/progress_by_node_segment` | — |
| GET | `/api/beta/cfgmgmt/rollouts/rollout/{rollout_id}` | GetRolloutById |
| POST | `/api/beta/cfgmgmt/rollouts/test_create` | CreateRolloutTest |
| POST | `/api/beta/content/credentials` | SubmitCredentials |
| GET | `/api/beta/content/enabled` | IsContentEnabled |
| POST | `/api/beta/content/install` | InstallContentItem |
| GET | `/api/beta/content/items` | ListContentItems |
| POST | `/api/v0/applications/delete_disconnected_services` | Remove Disconnected Services |
| POST | `/api/v0/applications/delete_services_by_id` | Delete the services with the given IDs |
| GET | `/api/v0/applications/disconnected_services` | Mark Services as Disconnected |
| GET | `/api/v0/applications/service-groups` | List Service Groups |
| GET | `/api/v0/applications/service-groups/{service_group_id}` | List Services for a Service Group |
| GET | `/api/v0/applications/service_groups_health_counts` | List Service Groups Health Counts |
| GET | `/api/v0/applications/services` | List Services |
| GET | `/api/v0/applications/services-distinct-values` | List Filter Values |
| GET | `/api/v0/applications/stats` | Show Summary |
| GET | `/api/v0/applications/telemetry/services/count` | — |
| PUT | `/api/v0/applications/telemetry/services/count/updated` | — |
| GET | `/api/v0/audit/admin/request` | RequestAdminAuditLogs initiates async generation of audit logs for selected users. NOTE: This is intended for admin-level access and is protected by IAM poli... |
| GET | `/api/v0/audit/download` | Download audit logs |
| GET | `/api/v0/audit/self/request` | RequestSelfAuditLogs initiates async generation of audit logs for the current user |
| GET | `/api/v0/audit/status` | GetAuditLogsRequestStatus checks the status of an audit log request |
| GET | `/api/v0/cfgmgmt/errors` | List Errors |
| GET | `/api/v0/cfgmgmt/node_metadata_counts` | GetNodeMetadataCounts |
| GET | `/api/v0/cfgmgmt/node_runs_daily_status_time_series` | GetNodeRunsDailyStatusTimeSeries |
| GET | `/api/v0/cfgmgmt/nodes` | List Checked-in Nodes |
| POST | `/api/v0/cfgmgmt/nodes/export` | NodeExport |
| GET | `/api/v0/cfgmgmt/nodes/{node_id}/attribute` | Show Attributes |
| GET | `/api/v0/cfgmgmt/nodes/{node_id}/runs` | List Run Details |
| GET | `/api/v0/cfgmgmt/nodes/{node_id}/runs/{run_id}` | Show Node Run |
| GET | `/api/v0/cfgmgmt/organizations` | List Organizations |
| GET | `/api/v0/cfgmgmt/policy_revision/{revision_id}` | List Policy Cookbooks |
| POST | `/api/v0/cfgmgmt/reports/export` | ReportExport |
| GET | `/api/v0/cfgmgmt/source_fqdns` | List Associated Chef Infra Servers |
| GET | `/api/v0/cfgmgmt/stats/checkin_counts_timeseries` | List Node Checkins |
| GET | `/api/v0/cfgmgmt/stats/missing_node_duration_counts` | List Missing Nodes Count |
| GET | `/api/v0/cfgmgmt/stats/node_counts` | List Node Status Counts |
| GET | `/api/v0/cfgmgmt/stats/run_counts` | List Run Status Totals |
| GET | `/api/v0/cfgmgmt/suggestions` | List Filter Suggestions |
| GET | `/api/v0/cfgmgmt/telemetry/nodes/count` | GetNodesUsageCount |
| 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 ``` |
| GET | `/api/v0/compliance/market/read/{name}/version/{version}` | Show an available profile |
| POST | `/api/v0/compliance/profiles` | Upload a Profile |
| POST | `/api/v0/compliance/profiles/metasearch` | Check if one or multiple profiles exist in the metadata database. |
| GET | `/api/v0/compliance/profiles/read/{owner}/{name}/version/{version}` | Show an installed profile |
| POST | `/api/v0/compliance/profiles/search` | List all available profiles |
| POST | `/api/v0/compliance/profiles/tar` | Download a Profile |
| DELETE | `/api/v0/compliance/profiles/{owner}/{name}/version/{version}` | Delete an installed profile |
| PUT | `/api/v0/compliance/reporting/assets/config` | Set Unreachable Assets Config |
| GET | `/api/v0/compliance/reporting/assets/config/search` | Get Assets Config |
| POST | `/api/v0/compliance/reporting/assets/count` | Assets Count |
| POST | `/api/v0/compliance/reporting/assets/search` | List Assets |
| POST | `/api/v0/compliance/reporting/controls` | List Controls |
| POST | `/api/v0/compliance/reporting/controls/search` | List Controls Search |
| POST | `/api/v0/compliance/reporting/export` | Export reports |
| POST | `/api/v0/compliance/reporting/node/export` | Export node reports |
| POST | `/api/v0/compliance/reporting/nodeheader/id/{id}` | Show Node Header Info From Report ID |

…and 217 more operations. The page lists the first 250; the full set of 277 is in the OpenAPI linked below.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/openapi/progress-software-chef-automate-openapi-original.json
- **Documentation** — https://docs.chef.io/automate/
- **APIReference** — https://docs.chef.io/automate/api/
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/apis.yml

## Other Progress Software APIs (4)

- [MOVEit Transfer REST API](https://apis.io/apis/progress-software/progress-software-moveit-transfer/)
- [WhatsUp Gold REST API](https://apis.io/apis/progress-software/progress-software-whatsup-gold/)
- [ShareFile API v3](https://apis.io/apis/progress-software/progress-software-sharefile/)
- [Sitefinity CMS Headless OData Services](https://apis.io/apis/progress-software/progress-software-sitefinity-odata/)

## Tags

Compliance, Configuration Management, DevOps, Infrastructure Automation

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/progress-software/progress-software-chef-automate/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/progress-software/.
