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 Software JobScheduler API

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

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

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 2.0, at version version not set.

Requests are made against the base URL https://automate.chef.io/api/v0.

4 operations 4 paths 8 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
version not set
Base URL
https://automate.chef.io/api/v0
Resource Areas
1

Paths & Operations 4

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

JobScheduler 4
POST
/api/v0/retention/nodes/delete-nodes/config
JobScheduler_ConfigureDeleteNodesScheduler 1 param → 200default
POST
/api/v0/retention/nodes/missing-nodes-deletion/config
JobScheduler_ConfigureMissingNodesForDeletionScheduler 1 param → 200default
POST
/api/v0/retention/nodes/missing-nodes/config
JobScheduler_ConfigureNodesMissingScheduler 1 param → 200default
GET
/api/v0/retention/nodes/status
JobScheduler_GetStatusJobScheduler → 200default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.ingest.response.Job (8 properties), grpc.gateway.runtime.Error (4 properties), chef.automate.api.ingest.request.SchedulerConfig (3 properties), google.protobuf.Any (2 properties). Each schema is shown below with its type and property counts.

chef.automate.api.ingest.response.ConfigureNodesMissingScheduler
object
chef.automate.api.ingest.response.Job
object
8 properties
chef.automate.api.ingest.request.SchedulerConfig
object
SchedulerConfig The job message to configure the Delete Node Job every - It accepts '1h30m', '1m', '2h30m', ...
3 properties
chef.automate.api.ingest.response.JobSchedulerStatus
object
2 properties
google.protobuf.Any
object
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.ingest.response.ConfigureMissingNodesForDeletionScheduler
object
chef.automate.api.ingest.response.ConfigureDeleteNodesScheduler
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-jobscheduler-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 JobsService API