Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fuomag9/caddy-proxy-manager/llms.txt

Use this file to discover all available pages before exploring further.

Access lists protect proxy hosts with HTTP basic authentication. Each list holds one or more username/password pairs; passwords are bcrypt-hashed before storage and are never returned in API responses.

​
Endpoints

MethodPathDescription
GET/api/v1/access-listsList all access lists
POST/api/v1/access-listsCreate an access list
GET/api/v1/access-lists/{id}Get an access list by ID
PUT/api/v1/access-lists/{id}Update an access list
DELETE/api/v1/access-lists/{id}Delete an access list

​
Create an access list

POST /api/v1/access-lists 
curl -X POST https://your-instance:3000/api/v1/access-lists \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "staging-team",
    "users": [
      {"username": "alice", "password": "s3cr3t-pass!"},
      {"username": "bob", "password": "another-pass!"}
    ]
  }'

​
Request fields

​
name
string
required
Display name for the access list (e.g. staging-team, internal-tools).
​
users
object[]
required
Array of user credentials.

​
Response object

{
  "id": 1,
  "name": "staging-team",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}
Passwords are never included in response objects.

​
Assign to a proxy host

To apply an access list to a proxy host, include accessListId in the proxy host create or update request: 
curl -X PUT https://your-instance:3000/api/v1/proxy-hosts/1 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accessListId": 1}'
One access list can be assigned to multiple proxy hosts simultaneously.

Build docs developers (and LLMs) love

Get started for freeTalk to us