HashiCorp Consul Operator API

Cluster operator endpoints

OpenAPI Specification

consul-operator-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: HashiCorp Consul HTTP ACL Operator 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: Operator
  description: Cluster operator endpoints
paths:
  /operator/raft/configuration:
    get:
      operationId: getRaftConfiguration
      summary: Read Raft configuration
      tags:
      - Operator
      parameters:
      - $ref: '#/components/parameters/dc'
      responses:
        '200':
          description: Raft configuration
          content:
            application/json:
              schema:
                type: object
                properties:
                  Servers:
                    type: array
                    items:
                      type: object
                      properties:
                        ID:
                          type: string
                        Node:
                          type: string
                        Address:
                          type: string
                        Leader:
                          type: boolean
                        Voter:
                          type: boolean
                  Index:
                    type: integer
components:
  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