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

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

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

This API exposes 10 operations across 6 paths, and defines 23 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.

10 operations 6 paths 23 schemas 1 DELETE4 GET3 POST2 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 10

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

policies 10
GET
/apis/iam/v2/policies
Lists all policies
Policies_ListPolicies → 200default
POST
/apis/iam/v2/policies
Creates a custom policy
Policies_CreatePolicy body → 200default
GET
/apis/iam/v2/policies/{id}
Gets a policy
Policies_GetPolicy 1 param → 200default
DELETE
/apis/iam/v2/policies/{id}
Deletes a custom policy
Policies_DeletePolicy 1 param → 200default
PUT
/apis/iam/v2/policies/{id}
Updates a custom policy
Policies_UpdatePolicy 1 param body → 200default
GET
/apis/iam/v2/policies/{id}/members
Lists policy members
Policies_ListPolicyMembers 1 param → 200default
PUT
/apis/iam/v2/policies/{id}/members
Replaces policy members
Policies_ReplacePolicyMembers 1 param body → 200default
POST
/apis/iam/v2/policies/{id}/members:add
Adds policy members
Policies_AddPolicyMembers 1 param body → 200default
POST
/apis/iam/v2/policies/{id}/members:remove
Removes policy members
Policies_RemovePolicyMembers 1 param body → 200default
GET
/apis/iam/v2/policy_version
Gets IAM version
Policies_GetPolicyVersion → 200default

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.iam.v2.Policy (6 properties), chef.automate.api.iam.v2.UpdatePolicyReq (5 properties), chef.automate.api.iam.v2.CreatePolicyReq (5 properties), chef.automate.api.iam.v2.Statement (5 properties). Each schema is shown below with its type and property counts.

chef.automate.api.iam.v2.GetPolicyVersionResp
object
1 property
chef.automate.api.iam.v2.ListPoliciesResp
object
1 property
chef.automate.api.iam.v2.RemovePolicyMembersReq
object
2 properties 2 required
chef.automate.api.iam.v2.DeletePolicyResp
object
chef.automate.api.iam.v2.Statement
object
5 properties
chef.automate.api.iam.v2.UpdatePolicyResp
object
1 property
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.iam.v2.UpdatePolicyReq
object
Does not contain type as the enduser can only create 'custom' policies.
5 properties 3 required
chef.automate.api.iam.v2.Policy
object
6 properties
chef.automate.api.iam.v2.RemovePolicyMembersResp
object
1 property
chef.automate.api.iam.v2.Statement.Effect
string
chef.automate.api.iam.v2.ReplacePolicyMembersReq
object
2 properties 1 required
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.iam.v2.AddPolicyMembersResp
object
1 property
chef.automate.api.iam.v2.CreatePolicyResp
object
1 property
chef.automate.api.iam.v2.AddPolicyMembersReq
object
2 properties 2 required
chef.automate.api.iam.v2.CreatePolicyReq
object
Does not contain type as the enduser can only create 'custom' policies.
5 properties 3 required
chef.automate.api.iam.v2.GetPolicyResp
object
1 property
chef.automate.api.iam.v2.ReplacePolicyMembersResp
object
1 property
chef.automate.api.iam.v2.ListPolicyMembersResp
object
1 property
chef.automate.api.iam.v2.Type
string
chef.automate.api.iam.v2.Version
object
2 properties
chef.automate.api.iam.v2.Version.VersionNumber
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

This is an independent, third-party profile of Chef Software policies 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.