Caddy Configuration API

openapi: 3.1.0
info:
  title: Caddy Admin Adapt Configuration API
  version: '1.0'
  description: Minimal OpenAPI 3.1 description of the Caddy web server admin API. By default the admin endpoint is bound to localhost:2019 and is used to inspect and dynamically modify the running configuration without restarts.
  x-generated-from: https://caddyserver.com/docs/api
  x-generated-by: claude-crawl-2026-05-08
servers:
- url: http://localhost:2019
  description: Default admin endpoint
tags:
- name: Configuration
paths:
  /config/{path}:
    parameters:
    - $ref: '#/components/parameters/PathParam'
    get:
      tags:
      - Configuration
      summary: Export current configuration at a named path
      operationId: getConfigPath
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'
    post:
      tags:
      - Configuration
      summary: Create or append to configuration at a named path
      operationId: postConfigPath
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Config'
      responses:
        '200':
          description: OK
    put:
      tags:
      - Configuration
      summary: Create new objects or insert into arrays at a named path
      operationId: putConfigPath
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Config'
      responses:
        '200':
          description: OK
    patch:
      tags:
      - Configuration
      summary: Replace existing configuration values at a named path
      operationId: patchConfigPath
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Config'
      responses:
        '200':
          description: OK
    delete:
      tags:
      - Configuration
      summary: Remove configuration at a named path
      operationId: deleteConfigPath
      responses:
        '200':
          description: OK
components:
  parameters:
    PathParam:
      name: path
      in: path
      required: true
      description: Configuration path traversal expression.
      schema:
        type: string
  schemas:
    Config:
      type: object
      additionalProperties: true