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

The rules API from Chef Software — 4 operation(s) for rules.

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

This API exposes 8 operations across 4 paths, and defines 19 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.

8 operations 4 paths 19 schemas 2 DELETE3 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 8

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

rules 8
GET
/apis/iam/v2/apply-rules
Get the status of a project update
Rules_ApplyRulesStatus → 200default
DELETE
/apis/iam/v2/apply-rules
Cancel project update
Rules_ApplyRulesCancel → 200default
POST
/apis/iam/v2/apply-rules
Start project update
Rules_ApplyRulesStart → 200default
GET
/apis/iam/v2/projects/{id}/rules
List a project's rules
Rules_ListRulesForProject 1 param → 200default
POST
/apis/iam/v2/projects/{project_id}/rules
Create a project rule
Rules_CreateRule 1 param body → 200default
GET
/apis/iam/v2/projects/{project_id}/rules/{id}
Get a project rule
Rules_GetRule 2 params → 200default
DELETE
/apis/iam/v2/projects/{project_id}/rules/{id}
Delete a project rule
Rules_DeleteRule 2 params → 200default
PUT
/apis/iam/v2/projects/{project_id}/rules/{id}
Update a project rule
Rules_UpdateRule 2 params body → 200default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.iam.v2.ApplyRulesStatusResp (6 properties), chef.automate.api.iam.v2.Rule (6 properties), chef.automate.api.iam.v2.UpdateRuleReq (5 properties), chef.automate.api.iam.v2.CreateRuleReq (5 properties). Each schema is shown below with its type and property counts.

chef.automate.api.iam.v2.RuleStatus
string
chef.automate.api.iam.v2.Condition
object
3 properties
chef.automate.api.iam.v2.GetRuleResp
object
1 property
chef.automate.api.iam.v2.ProjectRulesStatus
string
chef.automate.api.iam.v2.CreateRuleReq
object
5 properties 5 required
grpc.gateway.runtime.Error
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.iam.v2.ConditionAttribute
string
chef.automate.api.iam.v2.ApplyRulesStartResp
object
chef.automate.api.iam.v2.CreateRuleResp
object
1 property
chef.automate.api.iam.v2.ApplyRulesStatusResp
object
6 properties
chef.automate.api.iam.v2.ConditionOperator
string
chef.automate.api.iam.v2.ApplyRulesCancelResp
object
chef.automate.api.iam.v2.UpdateRuleResp
object
1 property
chef.automate.api.iam.v2.UpdateRuleReq
object
5 properties 5 required
chef.automate.api.iam.v2.DeleteRuleResp
object
chef.automate.api.iam.v2.Rule
object
6 properties
chef.automate.api.iam.v2.ListRulesForProjectResp
object
2 properties
chef.automate.api.iam.v2.RuleType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-rules-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 rules 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.