Caddy.Admin.Api (Caddy v1.0.7)

Control Caddy Server through admin socket

Admin API

POST /load Sets or replaces the active configuration
POST /stop Stops the active configuration and exits the process
GET /config/[path] Exports the config at the named path
POST /config/[path] Sets or replaces object; appends to array
PUT /config/[path] Creates new object; inserts into array
PATCH /config/[path] Replaces an existing object or array element
DELETE /config/[path] Deletes the value at the named path
Using @id in JSON Easily traverse into the config structure
Concurrent config changes Avoid collisions when making unsynchronized changes to config
POST /adapt Adapts a configuration to JSON without running it
GET /pki/ca/<id> Returns information about a particular PKI app CA
GET /pki/ca/<id>/certificates Returns the certificate chain of a particular PKI app CA
GET /reverse_proxy/upstreams Returns the current status of the configured proxy upstreams

Summary

Functions

adapt(conf)

Adapts a configuration to JSON without running it

delete_config()

delete_config(path)

Delete the config at the named path

get(path)

Get info from caddy server

get_config()

get_config(path)

Exports the config at the named path

load(conf)

Sets or replaces the active configuration

patch_config(data)

patch_config(path, data)

Patch the config at the named path

post_config(data)

post_config(path, data)

Post the config at the named path

put_config(data)

put_config(path, data)

Put the config at the named path

stop()

Stops the active configuration and exits the process