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

The SecretsService API from Chef Software — 3 operation(s) for secretsservice.

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

This API exposes 5 operations across 3 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.

5 operations 3 paths 11 schemas 1 DELETE1 GET1 PATCH2 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 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

SecretsService 5
POST
/api/v0/secrets
Create a secret
SecretsService_Create 1 param → 200default
GET
/api/v0/secrets/id/{id}
Read a secret
SecretsService_Read 1 param → 200default
DELETE
/api/v0/secrets/id/{id}
Delete a secret
SecretsService_Delete 1 param → 200default
PATCH
/api/v0/secrets/id/{id}
Update a secret
SecretsService_Update 2 params → 200default
POST
/api/v0/secrets/search
List and filter secrets
SecretsService_List 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.secrets.Secret (6 properties), chef.automate.api.secrets.Query (5 properties), grpc.gateway.runtime.Error (4 properties), chef.automate.api.common.query.Filter (3 properties). Each schema is shown below with its type and property counts.

chef.automate.api.secrets.Secret
object
6 properties
chef.automate.api.common.query.Kv
object
2 properties
chef.automate.api.secrets.Id
object
1 property
chef.automate.api.secrets.Query.OrderType
string
Return the results in ascending or descending order.
chef.automate.api.secrets.Secrets
object
2 properties
chef.automate.api.secrets.DeleteResponse
object
chef.automate.api.secrets.Query
object
5 properties
chef.automate.api.secrets.UpdateResponse
object
google.protobuf.Any
object
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.common.query.Filter
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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