Chef

Chef Scans API

The Scans API from Chef — 1 operation(s) for scans.

GitHub OpenAPI

Operations 1

POST /compliance/scanner/jobs Create a compliance scan job #

Documentation

📖
Documentation
https://docs.chef.io/server/api_chef_server/
📖
Authentication
https://docs.chef.io/server/server_security/
📖
Documentation
https://docs.chef.io/automate/api/
📖
Authentication
https://docs.chef.io/automate/api_tokens/
📖
Documentation
https://docs.habitat.sh/docs/using-builder/
📖
Authentication
https://docs.habitat.sh/docs/using-builder/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/chef/refs/heads/main/openapi/chef-scans-api-openapi.yml

Other Resources

🔗
Reference
https://docs.chef.io/automate/api_swagger/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/chef-scans-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

chef-scans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Chef Automate Scans API
  description: REST API for Chef Automate providing visibility into infrastructure convergence, compliance scans, and application deployment. Includes endpoints for nodes, profiles, scans, and reports.
  version: '1.0'
  contact:
    name: Chef Software
    url: https://www.chef.io/support
servers:
- url: https://{automate}/api/v0
  description: Chef Automate
  variables:
    automate:
      default: automate.example.com
security:
- apiToken: []
tags:
- name: Scans
paths:
  /compliance/scanner/jobs:
    post:
      operationId: createScanJob
      summary: Create a compliance scan job
      tags:
      - Scans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                profiles:
                  type: array
                  items:
                    type: string
                nodes:
                  type: array
                  items:
                    type: string
      responses:
        '201':
          description: Scan job created
components:
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: api-token
      description: API token issued through the Chef Automate UI or admin API.
externalDocs:
  description: Chef Automate API
  url: https://docs.chef.io/automate/api/