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

System backend operations (init, seal, mounts, auth, audit)

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

Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 21 operations across 15 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.15.0.

Requests are made against 2 base URLs: https://127.0.0.1:8200/v1, https://{vault_host}:{port}/v1.

21 operations 15 paths 4 schemas 4 DELETE8 GET4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.15.0
Base URL
https://127.0.0.1:8200/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

HashiCorp Vault System 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 client token

Paths & Operations 21

Across 15 paths, the API surfaces 21 operations — 4 DELETE, 8 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

System 21

System backend operations (init, seal, mounts, auth, audit)

GET
/sys/init
Check initialization status
getInitStatus → 200
PUT
/sys/init
Initialize Vault
initialize body → 200
GET
/sys/seal-status
Check seal status
getSealStatus → 200
PUT
/sys/seal
Seal the Vault
seal → 204
PUT
/sys/unseal
Submit an unseal key
unseal body → 200
GET
/sys/health
Health status
getHealth 5 params → 200429472473501503
GET
/sys/mounts
List mounted secrets engines
listSecretEngines → 200
POST
/sys/mounts/{path}
Enable a secrets engine
enableSecretEngine 1 param body → 204
DELETE
/sys/mounts/{path}
Disable a secrets engine
disableSecretEngine 1 param → 204
GET
/sys/auth
List auth methods
listAuthMethods → 200
POST
/sys/auth/{path}
Enable an auth method
enableAuthMethod 1 param body → 204
DELETE
/sys/auth/{path}
Disable an auth method
disableAuthMethod 1 param → 204
GET
/sys/audit
List audit devices
listAuditDevices → 200
PUT
/sys/audit/{path}
Enable an audit device
enableAuditDevice 1 param body → 204
DELETE
/sys/audit/{path}
Disable an audit device
disableAuditDevice 1 param → 204
GET
/sys/generate-root/attempt
Read root generation progress
getRootGenerationProgress → 200
PUT
/sys/generate-root/attempt
Start root token generation
startRootGeneration body → 200
DELETE
/sys/generate-root/attempt
Cancel root token generation
cancelRootGeneration → 204
GET
/sys/leader
Get leader information
getLeader → 200
POST
/sys/wrapping/wrap
Wrap data
wrap 1 param body → 200
POST
/sys/wrapping/unwrap
Unwrap data
unwrap body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SealStatus (14 properties), HealthStatus (10 properties), VaultResponse (8 properties), MountConfig (8 properties). Each schema is shown below with its type and property counts.

MountConfig
object
8 properties
VaultResponse
object
8 properties
SealStatus
object
14 properties
HealthStatus
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-vault-system-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

HashiCorp Vault Auth - AppRole API
HashiCorp Vault Auth - Token API
HashiCorp Vault Auth - Userpass API
HashiCorp Vault Identity API
HashiCorp Vault Leases API
HashiCorp Vault Policy API
HashiCorp Vault Secrets - KV v2 API
HashiCorp Vault Secrets - Transit API