How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chef Software JobsService API

The JobsService API from Chef Software — 4 operation(s) for jobsservice.

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 3.2.0, at version version not set.

Requests are made against a single base URL, https://automate.chef.io/api/v0.

6 operations 4 paths 12 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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_Create body → 200default
GET
/api/v0/compliance/scanner/jobs/id/{id}
Read a scan job
JobsService_Read 2 params → 200default
DELETE
/api/v0/compliance/scanner/jobs/id/{id}
Delete a scan job
JobsService_Delete 2 params → 200default
PUT
/api/v0/compliance/scanner/jobs/id/{id}
Update a job
JobsService_Update 1 param body → 200default
GET
/api/v0/compliance/scanner/jobs/rerun/id/{id}
Rerun a scan job
JobsService_Rerun 2 params → 200default
POST
/api/v0/compliance/scanner/jobs/search
List of scan jobs
JobsService_List body → 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.

chef.automate.api.compliance.scanner.jobs.v1.Job
object
21 properties
chef.automate.api.compliance.scanner.jobs.v1.ResultsRow
object
7 properties
chef.automate.api.compliance.scanner.jobs.v1.Query
object
5 properties
chef.automate.api.common.query.Filter
object
3 properties
chef.automate.api.compliance.scanner.jobs.v1.Query.OrderType
string
Return the results in ascending or descending order.
chef.automate.api.compliance.scanner.jobs.v1.RerunResponse
object
chef.automate.api.compliance.scanner.jobs.v1.Id
object
2 properties
google.protobuf.Any
object
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.common.query.Kv
object
2 properties
chef.automate.api.compliance.scanner.jobs.v1.ManagerFilter
object
2 properties
chef.automate.api.compliance.scanner.jobs.v1.Jobs
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-jobsservice-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 JobScheduler API
Where this information came from

This is an independent, third-party profile of Chef Software JobsService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.