openapi: 3.1.0
info:
  title: Chef Automate Channels 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/