openapi: 3.1.0
info:
  title: HashiCorp Consul HTTP ACL Config Entries 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: Config Entries
  description: Centralized configuration entries
paths:
  /config/{kind}:
    get:
      operationId: listConfigEntries
      summary: List config entries by kind
      tags:
      - Config Entries
      parameters:
      - name: kind
        in: path
        required: true
        schema:
          type: string
          enum:
          - service-defaults
          - proxy-defaults
          - service-router
          - service-splitter
          - service-resolver
          - ingress-gateway
          - terminating-gateway
          - service-intentions
          - mesh
          - exported-services
      - $ref: '#/components/parameters/dc'
      responses:
        '200':
          description: List of config entries
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
  /config:
    put:
      operationId: applyConfigEntry
      summary: Apply a config entry
      tags:
      - Config Entries
      parameters:
      - $ref: '#/components/parameters/dc'
      - name: cas
        in: query
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - Kind
              - Name
              properties:
                Kind:
                  type: string
                Name:
                  type: string
      responses:
        '200':
          description: Config entry applied
  /config/{kind}/{name}:
    get:
      operationId: getConfigEntry
      summary: Get a config entry
      tags:
      - Config Entries
      parameters:
      - name: kind
        in: path
        required: true
        schema:
          type: string
      - name: name
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/dc'
      responses:
        '200':
          description: Config entry
          content:
            application/json:
              schema:
                type: object
    delete:
      operationId: deleteConfigEntry
      summary: Delete a config entry
      tags:
      - Config Entries
      parameters:
      - name: kind
        in: path
        required: true
        schema:
          type: string
      - name: name
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/dc'
      - name: cas
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Config entry deleted
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