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

Health and status endpoints

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

Tagged areas include Health. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.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.1.0
API Version
1.0
Base URL
https://vault.example.com/v1/sys
Authentication
API Key
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 authentication token

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

Health and status endpoints

GET
/sys/health
HashiCorp Vault Read health status
getSystemHealth 5 params → 200429472501503

Schemas 1

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

HealthResponse
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hvault-health-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

HashiCorp Vault AppRole API
HashiCorp Vault Audit API
HashiCorp Vault Auth API
HashiCorp Vault AWS API
HashiCorp Vault Configuration API
HashiCorp Vault Database API
HashiCorp Vault Entity Alias API
HashiCorp Vault Entity API
HashiCorp Vault GitHub API
HashiCorp Vault Group Alias API
HashiCorp Vault Group API
HashiCorp Vault Init API