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 retention API

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

Chef Software retention 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 retention. 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 11 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 operations 4 paths 11 schemas 2 GET4 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 6

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

retention 6
GET
/api/v0/retention/service_groups/delete_disconnected_services/config
Show 'Remove Disconnected Services' Configuration
ApplicationsService_GetDeleteDisconnectedServicesConfig → 200default
POST
/api/v0/retention/service_groups/delete_disconnected_services/config
Change 'Remove Disconnected Services' Configuration
ApplicationsService_UpdateDeleteDisconnectedServicesConfig 1 param → 200default
POST
/api/v0/retention/service_groups/delete_disconnected_services/run
ApplicationsService_RunDeleteDisconnectedServicesJob 1 param → 200default
GET
/api/v0/retention/service_groups/disconnected_services/config
Show 'Disconnected Services' configuration
ApplicationsService_GetDisconnectedServicesConfig → 200default
POST
/api/v0/retention/service_groups/disconnected_services/config
Change 'Disconnected Services' Configuration
ApplicationsService_UpdateDisconnectedServicesConfig 1 param → 200default
POST
/api/v0/retention/service_groups/disconnected_services/run
Runs the job to mark services as disconnected immediately.
ApplicationsService_RunDisconnectedServicesJob 1 param → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.applications.PeriodicJobInfo (5 properties), chef.automate.api.applications.PeriodicMandatoryJobConfig (4 properties), chef.automate.api.applications.PeriodicJobConfig (4 properties), grpc.gateway.runtime.Error (4 properties). Each schema is shown below with its type and property counts.

chef.automate.api.applications.RunDeleteDisconnectedServicesJobReq
object
chef.automate.api.applications.RunDisconnectedServicesJobResponse
object
chef.automate.api.applications.RunDeleteDisconnectedServicesJobResponse
object
chef.automate.api.applications.PeriodicJobConfig
object
Periodic job configuration.
4 properties
chef.automate.api.applications.UpdateDisconnectedServicesConfigRes
object
google.protobuf.Any
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
2 properties
chef.automate.api.applications.PeriodicJobInfo
object
PeriodicJobInfo gives information about the last and next scheduled executions of a periodic job.
5 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.applications.RunDisconnectedServicesJobReq
object
chef.automate.api.applications.PeriodicMandatoryJobConfig
object
Configuration for a periodic job. Initially Jobs using this message type were designed such that they could not be disabled, but that has been changed to make…
4 properties
chef.automate.api.applications.UpdateDeleteDisconnectedServicesConfigRes
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-retention-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