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 Vault Health API

Check Vault health and initialization status.

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

This API exposes 5 JSON Schema definitions.

Tagged areas include Health. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://vault.example.com/v1.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://vault.example.com/v1
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

HashiCorp Vault Health API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Vault-Token (vaultToken). By default, every request must be authenticated.

  • vaultToken — Vault token for authenticating API requests. Tokens can be created via login endpoints or the token auth method. The token must have appropriate policy permiss…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Health 1

Check Vault health and initialization status.

GET
/sys/health
HashiCorp Vault Get Health Status
getHealth → 200429503

Schemas 1

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

HealthResponse
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vault-health-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

Vault HTTP API
HashiCorp Vault Auth Methods API
HashiCorp Vault Leases API
HashiCorp Vault Policies API
HashiCorp Vault Secrets Config API
HashiCorp Vault Secrets Data API
HashiCorp Vault Secrets Engines API
HashiCorp Vault Secrets Metadata API