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 Consul Status API

Cluster status information

HashiCorp Consul Status API is one of 14 APIs that HashiCorp Consul publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.18.0.

Requests are made against 2 base URLs: http://localhost:8500/v1, https://{consul_host}:{port}/v1.

2 operations 2 paths 0 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.18.0
Base URL
http://localhost:8500/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

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

  • ConsulToken — ACL token for authentication

Paths & Operations 2

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

Status 2

Cluster status information

GET
/status/leader
Get Raft leader
getStatusLeader → 200
GET
/status/peers
List Raft peers
getStatusPeers → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

consul-status-api-openapi.yml Raw ↑

Other APIs HashiCorp Consul publishes across the network.

HashiCorp Consul ACL API
HashiCorp Consul Agent API
HashiCorp Consul Catalog API
HashiCorp Consul Config Entries API
HashiCorp Consul Connect API
HashiCorp Consul Coordinates API
HashiCorp Consul Events API
HashiCorp Consul Health API
HashiCorp Consul KV Store API
HashiCorp Consul Operator API
HashiCorp Consul Sessions API
HashiCorp Consul Snapshot API