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

Caddy Configuration API

The Configuration API from Caddy — 1 operation(s) for configuration.

Caddy Configuration API is one of 6 APIs that Caddy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and a GitHub repository.

This API exposes 5 operations across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, http://localhost:2019.

5 operations 1 paths 1 schemas 1 DELETE1 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
http://localhost:2019
Resource Areas
1

Paths & Operations 5

Across 1 path, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Configuration 5
GET
/config/{path}
Export current configuration at a named path
getConfigPath 1 param → 200
POST
/config/{path}
Create or append to configuration at a named path
postConfigPath 1 param body → 200
PUT
/config/{path}
Create new objects or insert into arrays at a named path
putConfigPath 1 param body → 200
PATCH
/config/{path}
Replace existing configuration values at a named path
patchConfigPath 1 param body → 200
DELETE
/config/{path}
Remove configuration at a named path
deleteConfigPath 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

Config
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

caddy-configuration-api-openapi.yml Raw ↑

Other APIs Caddy publishes across the network.

Caddy Admin API
Caddy Adapt API
Caddy Lifecycle API
Caddy PKI API
Caddy Reverse Proxy API