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

HashiCorp Cloud Platform Secrets API

Static and rotating secrets

HashiCorp Cloud Platform Secrets API is one of 9 APIs that HashiCorp Cloud Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Secrets. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2023-11-28.

Requests are made against a single base URL, https://api.cloud.hashicorp.com.

4 operations 3 paths 1 schemas 1 DELETE3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2023-11-28
Base URL
https://api.cloud.hashicorp.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

HashiCorp Cloud Platform Secrets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Secrets 4

Static and rotating secrets

GET
/secrets/2023-11-28/organizations/{org_id}/projects/{project_id}/apps/{app_name}/secrets
List secrets
listSecrets 3 params → 200
GET
/secrets/2023-11-28/organizations/{org_id}/projects/{project_id}/apps/{app_name}/secrets/{name}
Get secret
getSecret 4 params → 200
DELETE
/secrets/2023-11-28/organizations/{org_id}/projects/{project_id}/apps/{app_name}/secrets/{name}
Delete secret
deleteSecret 4 params → 200
GET
/secrets/2023-11-28/organizations/{org_id}/projects/{project_id}/apps/{app_name}/secrets/{name}:open
Open (read) a secret value
openSecret 4 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Secret (4 properties). Each schema is shown below with its type and property counts.

Secret
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hcp-secrets-api-openapi.yml Raw ↑

Other APIs HashiCorp Cloud Platform publishes across the network.

HCP Packer API
HCP Consul API
HCP Boundary API
HCP Waypoint API
HashiCorp Cloud Platform Apps API
HashiCorp Cloud Platform Gateway API
HashiCorp Cloud Platform Integrations API
HashiCorp Cloud Platform Sync API