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

The Roles API from Chef — 2 operation(s) for roles.

Chef Roles API is one of 14 APIs that Chef publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 3 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.0.

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

3 operations 2 paths 0 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://chef.example.com/organizations/example
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Chef Roles API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-token (apiToken). By default, every request must be authenticated.

  • apiToken — API token issued through the Chef Automate UI or admin API.

Paths & Operations 3

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

Roles 3
GET
/roles
List roles
listRoles → 200
POST
/roles
Create a role
createRole body → 201
GET
/roles/{roleName}
Get a role
getRole 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-roles-api-openapi.yml Raw ↑

Other APIs Chef publishes across the network.

Chef InSpec
Chef Channels API
Chef Clients API
Chef Cookbooks API
Chef Data Bags API
Chef Environments API
Chef IAM API
Chef Nodes API
Chef Packages API
Chef Profiles API
Chef Reports API
Chef Scans API