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 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 2.0, at version version not set.

Requests are made against the 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 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 1 param → 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 2 params → 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 2 params → 200default
POST
/apis/iam/v2/policies/{id}/members:add
Adds policy members
Policies_AddPolicyMembers 2 params → 200default
POST
/apis/iam/v2/policies/{id}/members:remove
Removes policy members
Policies_RemovePolicyMembers 2 params → 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.ListPoliciesResp
object
1 property
chef.automate.api.iam.v2.Type
string
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.Policy
object
6 properties
chef.automate.api.iam.v2.AddPolicyMembersReq
object
2 properties 2 required
chef.automate.api.iam.v2.UpdatePolicyResp
object
1 property
chef.automate.api.iam.v2.RemovePolicyMembersResp
object
1 property
chef.automate.api.iam.v2.ListPolicyMembersResp
object
1 property
chef.automate.api.iam.v2.Statement.Effect
string
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.Version
object
2 properties
chef.automate.api.iam.v2.CreatePolicyResp
object
1 property
chef.automate.api.iam.v2.Version.VersionNumber
string
chef.automate.api.iam.v2.ReplacePolicyMembersResp
object
1 property
chef.automate.api.iam.v2.RemovePolicyMembersReq
object
2 properties 2 required
chef.automate.api.iam.v2.ReplacePolicyMembersReq
object
2 properties 1 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.AddPolicyMembersResp
object
1 property
chef.automate.api.iam.v2.DeletePolicyResp
object
chef.automate.api.iam.v2.GetPolicyResp
object
1 property
chef.automate.api.iam.v2.Statement
object
5 properties
chef.automate.api.iam.v2.GetPolicyVersionResp
object
1 property

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