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

The DataLifecycle API from Chef Software — 15 operation(s) for datalifecycle.

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

This API exposes 15 operations across 15 paths, and defines 35 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.

15 operations 15 paths 35 schemas 5 GET5 POST5 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 15

Across 15 paths, the API surfaces 15 operations — 5 GET, 5 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

DataLifecycle 15
PUT
/api/v0/data-lifecycle/compliance/config
SetComplianceConfig configures the compliance data lifecycle scheduler and jobs
DataLifecycle_SetComplianceConfig 1 param → 200default
POST
/api/v0/data-lifecycle/compliance/run
RunCompliance runs the compliance data lifecycle jobs
DataLifecycle_RunCompliance 1 param → 200default
GET
/api/v0/data-lifecycle/compliance/status
GetComplianceStatus returns the compliance job scheduler status
DataLifecycle_GetComplianceStatus → 200default
PUT
/api/v0/data-lifecycle/config
SetConfig provides a singular endpoint for configuring all data lifecycle jobs
DataLifecycle_SetConfig 1 param → 200default
PUT
/api/v0/data-lifecycle/event-feed/config
SetEventFeedConfig configures the event feed data lifecycle scheduler and jobs
DataLifecycle_SetEventFeedConfig 1 param → 200default
POST
/api/v0/data-lifecycle/event-feed/run
RunEventFeed runs the event feed data lifecycle jobs
DataLifecycle_RunEventFeed 1 param → 200default
GET
/api/v0/data-lifecycle/event-feed/status
GetEventFeedStatus returns the event feed job scheduler status
DataLifecycle_GetEventFeedStatus → 200default
PUT
/api/v0/data-lifecycle/infra/config
SetInfraConfig configures the infra data lifecycle scheduler and jobs
DataLifecycle_SetInfraConfig 1 param → 200default
POST
/api/v0/data-lifecycle/infra/run
RunInfra runs the infra data lifecycle jobs
DataLifecycle_RunInfra 1 param → 200default
GET
/api/v0/data-lifecycle/infra/status
GetInfraStatus returns the infra job scheduler status
DataLifecycle_GetInfraStatus → 200default
POST
/api/v0/data-lifecycle/run
Run runs all data lifecycle actions across all data lifecycle jobs
DataLifecycle_Run 1 param → 200default
PUT
/api/v0/data-lifecycle/services/config
DataLifecycle_SetServicesConfig 1 param → 200default
POST
/api/v0/data-lifecycle/services/run
DataLifecycle_RunServices 1 param → 200default
GET
/api/v0/data-lifecycle/services/status
Services
DataLifecycle_GetServicesStatus → 200default
GET
/api/v0/data-lifecycle/status
GetStatus returns the aggregate status across all data lifecycle jobs
DataLifecycle_GetStatus → 200default

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.data_lifecycle.JobStatus (10 properties), chef.automate.api.data_lifecycle.EsPolicy (5 properties), chef.automate.api.data_lifecycle.JobSettings (5 properties), chef.automate.api.data_lifecycle.SetConfigRequest (4 properties). Each schema is shown below with its type and property counts.

chef.automate.api.data_lifecycle.SetComplianceConfigRequest
object
1 property
chef.automate.api.data_lifecycle.GetServicesStatusResponse
object
1 property
chef.automate.api.data_lifecycle.RunServicesResponse
object
chef.automate.api.data_lifecycle.SetInfraConfigRequest
object
1 property
chef.automate.api.data_lifecycle.PgPolicy
object
2 properties
chef.automate.api.data_lifecycle.RunEventFeedResponse
object
chef.automate.api.data_lifecycle.PgPolicyUpdate
object
2 properties
google.protobuf.Any
object
2 properties
chef.automate.api.data_lifecycle.RunResponse
object
chef.automate.api.data_lifecycle.SetServicesConfigRequest
object
1 property
chef.automate.api.data_lifecycle.SetComplianceConfigResponse
object
chef.automate.api.data_lifecycle.RunServicesRequest
object
chef.automate.api.data_lifecycle.RunInfraRequest
object
chef.automate.api.data_lifecycle.RunRequest
object
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.data_lifecycle.GetInfraStatusResponse
object
1 property
chef.automate.api.data_lifecycle.PurgePolicyUpdate
object
2 properties
chef.automate.api.data_lifecycle.EsPolicyUpdate
object
3 properties
chef.automate.api.data_lifecycle.GetComplianceStatusResponse
object
1 property
chef.automate.api.data_lifecycle.RunComplianceResponse
object
chef.automate.api.data_lifecycle.JobStatus
object
JobStatus presents the current configuration of job, when it will be executed, and details about it's most recent execution.
10 properties
chef.automate.api.data_lifecycle.GetEventFeedStatusResponse
object
1 property
chef.automate.api.data_lifecycle.RunInfraResponse
object
chef.automate.api.data_lifecycle.GetStatusResponse
object
4 properties
chef.automate.api.data_lifecycle.SetInfraConfigResponse
object
chef.automate.api.data_lifecycle.JobSettings
object
5 properties
chef.automate.api.data_lifecycle.SetConfigResponse
object
chef.automate.api.data_lifecycle.RunComplianceRequest
object
chef.automate.api.data_lifecycle.SetServicesConfigResponse
object
chef.automate.api.data_lifecycle.PurgePolicies
object
2 properties
chef.automate.api.data_lifecycle.SetEventFeedConfigResponse
object
chef.automate.api.data_lifecycle.SetEventFeedConfigRequest
object
1 property
chef.automate.api.data_lifecycle.RunEventFeedRequest
object
chef.automate.api.data_lifecycle.EsPolicy
object
5 properties
chef.automate.api.data_lifecycle.SetConfigRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-datalifecycle-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 EventFeedService API
Chef Software hidden API
Chef Software InfraProxy API
Chef Software JobScheduler API
Chef Software JobsService API