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

The ProfilesService API from Chef Software — 5 operation(s) for profilesservice.

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

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

5 operations 5 paths 18 schemas 1 DELETE2 GET2 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 5

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

ProfilesService 5
GET
/api/v0/compliance/market/read/{name}/version/{version}
Show an available profile
ProfilesService_ReadFromMarket 3 params → 200default
POST
/api/v0/compliance/profiles/metasearch
Check if one or multiple profiles exist in the metadata database.
ProfilesService_MetaSearch 1 param → 200default
GET
/api/v0/compliance/profiles/read/{owner}/{name}/version/{version}
Show an installed profile
ProfilesService_Read 3 params → 200default
POST
/api/v0/compliance/profiles/search
List all available profiles
ProfilesService_List 1 param → 200default
DELETE
/api/v0/compliance/profiles/{owner}/{name}/version/{version}
Delete an installed profile
ProfilesService_Delete 3 params → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.compliance.profiles.v1.Profile (16 properties), chef.automate.api.compliance.profiles.v1.Dependency (11 properties), chef.automate.api.compliance.profiles.v1.Control (9 properties), chef.automate.api.compliance.profiles.v1.Query (8 properties). Each schema is shown below with its type and property counts.

chef.automate.api.compliance.profiles.v1.SourceLocation
object
2 properties
chef.automate.api.compliance.profiles.v1.Ref
object
2 properties
chef.automate.api.compliance.profiles.v1.Control
object
9 properties
chef.automate.api.compliance.profiles.v1.Sha256
object
1 property
chef.automate.api.compliance.profiles.v1.Query
object
8 properties
chef.automate.api.compliance.profiles.v1.Missing
object
1 property
chef.automate.api.compliance.profiles.v1.Profiles
object
2 properties
chef.automate.api.compliance.profiles.v1.Profile
object
16 properties
chef.automate.api.compliance.profiles.v1.ListFilter
object
2 properties
chef.automate.api.compliance.profiles.v1.Dependency
object
11 properties
chef.automate.api.compliance.profiles.v1.Support
object
5 properties
google.protobuf.Any
object
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.compliance.profiles.v1.Result
object
6 properties
chef.automate.api.compliance.profiles.v1.Option
object
2 properties
chef.automate.api.compliance.profiles.v1.Group
object
3 properties
chef.automate.api.compliance.profiles.v1.Query.OrderType
string
chef.automate.api.compliance.profiles.v1.Attribute
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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