Chef Software

Chef Software JobScheduler API

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

GitHub OpenAPI

Operations 4

POST /api/v0/retention/nodes/delete-nodes/config #
POST /api/v0/retention/nodes/missing-nodes-deletion/config #
POST /api/v0/retention/nodes/missing-nodes/config #
GET /api/v0/retention/nodes/status #

Documentation

📖
Documentation
https://docs.chef.io/automate/api/
📖
Authentication
https://docs.chef.io/automate/api_tokens/

Specifications

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

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-software-jobscheduler-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

chef-software-jobscheduler-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: external/applications/applications.proto ApplicationsService Job Scheduler API
  version: version not set
servers:
- url: https://automate.chef.io/api/v0
tags:
- name: JobScheduler
paths:
  /api/v0/retention/nodes/delete-nodes/config:
    post:
      operationId: JobScheduler_ConfigureDeleteNodesScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.ConfigureDeleteNodesScheduler'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - JobScheduler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.ingest.request.SchedulerConfig'
        required: true
  /api/v0/retention/nodes/missing-nodes-deletion/config:
    post:
      operationId: JobScheduler_ConfigureMissingNodesForDeletionScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.ConfigureMissingNodesForDeletionScheduler'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - JobScheduler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.ingest.request.SchedulerConfig'
        required: true
  /api/v0/retention/nodes/missing-nodes/config:
    post:
      operationId: JobScheduler_ConfigureNodesMissingScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.ConfigureNodesMissingScheduler'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - JobScheduler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.ingest.request.SchedulerConfig'
        required: true
  /api/v0/retention/nodes/status:
    get:
      operationId: JobScheduler_GetStatusJobScheduler
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.ingest.response.JobSchedulerStatus'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - JobScheduler
components:
  schemas:
    chef.automate.api.ingest.response.ConfigureNodesMissingScheduler:
      type: object
    chef.automate.api.ingest.response.Job:
      type: object
      properties:
        running:
          type: boolean
        name:
          type: string
        every:
          type: string
        last_run:
          type: string
        next_run:
          type: string
        last_elapsed:
          type: string
        started_on:
          type: string
        threshold:
          type: string
    chef.automate.api.ingest.response.ConfigureMissingNodesForDeletionScheduler:
      type: object
    chef.automate.api.ingest.request.SchedulerConfig:
      type: object
      properties:
        every:
          type: string
        threshold:
          type: string
        running:
          type: boolean
      description: 'SchedulerConfig

        The job message to configure the Delete Node Job

        every - It accepts ''1h30m'', ''1m'', ''2h30m'', ...'
    google.protobuf.Any:
      type: object
      properties:
        type_url:
          type: string
        value:
          type: string
          format: byte
    grpc.gateway.runtime.Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    chef.automate.api.ingest.response.JobSchedulerStatus:
      type: object
      properties:
        running:
          type: boolean
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/chef.automate.api.ingest.response.Job'
    chef.automate.api.ingest.response.ConfigureDeleteNodesScheduler:
      type: object