HashiCorp Consul

HashiCorp Consul Health API

Query health check information

GitHub OpenAPI

Operations 4

GET /health/node/{node} List checks for a node #
GET /health/checks/{serviceName} List checks for a service #
GET /health/service/{serviceName} List service instances with health #
GET /health/state/{state} List checks in a state #

Documentation

📖
Documentation
https://developer.hashicorp.com/consul/api-docs
📖
Authentication
https://developer.hashicorp.com/consul/api-docs/api-structure

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/consul/refs/heads/main/openapi/consul-health-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/hashicorp/consul

Other Resources

🔗
ACL Documentation
https://developer.hashicorp.com/consul/docs/security/acl

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/consul-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

consul-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HashiCorp Consul HTTP ACL Health API
  description: The Consul HTTP API provides full access to Consul functionality including service discovery, health checking, key/value storage, ACL management, Connect service mesh, configuration entries, and multi-datacenter operations.
  version: 1.18.0
  contact:
    name: HashiCorp
    url: https://www.consul.io/
  license:
    name: Business Source License 1.1
    url: https://github.com/hashicorp/consul/blob/main/LICENSE
servers:
- url: http://localhost:8500/v1
  description: Local Consul agent
- url: https://{consul_host}:{port}/v1
  description: Custom Consul server
  variables:
    consul_host:
      default: localhost
    port:
      default: '8500'
security:
- ConsulToken: []
tags:
- name: Health
  description: Query health check information
paths:
  /health/node/{node}:
    get:
      operationId: getHealthNode
      summary: List checks for a node
      description: Returns the checks specific to the node provided.
      tags:
      - Health
      parameters:
      - name: node
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/dc'
      - name: filter
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of health checks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HealthCheck'
  /health/checks/{serviceName}:
    get:
      operationId: getHealthChecks
      summary: List checks for a service
      description: Returns the checks associated with the service provided.
      tags:
      - Health
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/dc'
      - name: near
        in: query
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of health checks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HealthCheck'
  /health/service/{serviceName}:
    get:
      operationId: getHealthService
      summary: List service instances with health
      description: Returns the service instances providing the service along with health check information.
      tags:
      - Health
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/dc'
      - name: near
        in: query
        schema:
          type: string
      - name: tag
        in: query
        schema:
          type: string
      - name: passing
        in: query
        schema:
          type: boolean
        description: Filter to only passing instances
      - name: filter
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Service instances with health info
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    Node:
                      $ref: '#/components/schemas/CatalogNode'
                    Service:
                      $ref: '#/components/schemas/AgentService'
                    Checks:
                      type: array
                      items:
                        $ref: '#/components/schemas/HealthCheck'
  /health/state/{state}:
    get:
      operationId: getHealthState
      summary: List checks in a state
      description: Returns the checks in the specified state (any, passing, warning, critical).
      tags:
      - Health
      parameters:
      - name: state
        in: path
        required: true
        schema:
          type: string
          enum:
          - any
          - passing
          - warning
          - critical
      - $ref: '#/components/parameters/dc'
      - name: filter
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of health checks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HealthCheck'
components:
  schemas:
    AgentService:
      type: object
      properties:
        ID:
          type: string
        Service:
          type: string
        Tags:
          type: array
          items:
            type: string
        Meta:
          type: object
          additionalProperties:
            type: string
        Port:
          type: integer
        Address:
          type: string
        EnableTagOverride:
          type: boolean
        Weights:
          type: object
          properties:
            Passing:
              type: integer
            Warning:
              type: integer
        Namespace:
          type: string
    HealthCheck:
      type: object
      properties:
        Node:
          type: string
        CheckID:
          type: string
        Name:
          type: string
        Status:
          type: string
          enum:
          - passing
          - warning
          - critical
        Notes:
          type: string
        Output:
          type: string
        ServiceID:
          type: string
        ServiceName:
          type: string
        ServiceTags:
          type: array
          items:
            type: string
        Type:
          type: string
        CreateIndex:
          type: integer
        ModifyIndex:
          type: integer
    CatalogNode:
      type: object
      properties:
        ID:
          type: string
        Node:
          type: string
        Address:
          type: string
        Datacenter:
          type: string
        TaggedAddresses:
          type: object
          additionalProperties:
            type: string
        Meta:
          type: object
          additionalProperties:
            type: string
        CreateIndex:
          type: integer
        ModifyIndex:
          type: integer
  parameters:
    dc:
      name: dc
      in: query
      description: Datacenter to query (defaults to agent's datacenter)
      schema:
        type: string
  securitySchemes:
    ConsulToken:
      type: apiKey
      name: X-Consul-Token
      in: header
      description: ACL token for authentication