Chef Software JobsService 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 JobsService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
6 operations
across 4 paths,
and defines 12 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.
6 operations4 paths12 schemas1 DELETE2 GET2 POST1 PUT
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 6
Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
JobsService 6
POST
/api/v0/compliance/scanner/jobs
Create a scan job
JobsService_Create1 param→ 200default
GET
/api/v0/compliance/scanner/jobs/id/{id}
Read a scan job
JobsService_Read2 params→ 200default
DELETE
/api/v0/compliance/scanner/jobs/id/{id}
Delete a scan job
JobsService_Delete2 params→ 200default
PUT
/api/v0/compliance/scanner/jobs/id/{id}
Update a job
JobsService_Update2 params→ 200default
GET
/api/v0/compliance/scanner/jobs/rerun/id/{id}
Rerun a scan job
JobsService_Rerun2 params→ 200default
POST
/api/v0/compliance/scanner/jobs/search
List of scan jobs
JobsService_List1 param→ 200default
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.compliance.scanner.jobs.v1.Job (21 properties), chef.automate.api.compliance.scanner.jobs.v1.ResultsRow (7 properties), chef.automate.api.compliance.scanner.jobs.v1.Query (5 properties), grpc.gateway.runtime.Error (4 properties). Each schema is shown below with its type and property counts.
