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.

The users, groups, and tokens APIs allow programmatic management of dashboard accounts and access control. All endpoints require an Admin-level API token.

​
User endpoints

MethodPathDescription
GET/api/v1/usersList all users
GET/api/v1/users/{id}Get a user by ID
PUT/api/v1/users/{id}Update a user
DELETE/api/v1/users/{id}Delete a user

​
Update a user

PUT /api/v1/users/{id} 
curl -X PUT https://your-instance:3000/api/v1/users/2 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"role": "admin"}'
​
role
"admin" | "user" | "viewer"
The user’s dashboard role. See User Management for capability details.
​
enabled
boolean
Set to false to suspend the account without deleting it.

​
User response object

{
  "id": 2,
  "name": "Alice Smith",
  "email": "alice@example.com",
  "role": "admin",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

​
Group endpoints

MethodPathDescription
GET/api/v1/groupsList all groups
POST/api/v1/groupsCreate a group
GET/api/v1/groups/{id}Get a group by ID
PUT/api/v1/groups/{id}Update a group
DELETE/api/v1/groups/{id}Delete a group

​
Create a group

POST /api/v1/groups 
curl -X POST https://your-instance:3000/api/v1/groups \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "engineering"}'
​
name
string
required
Display name for the group.
Groups are used with the Forward Auth Portal to grant access to protected proxy hosts. See Forward Auth for details.

​
API token endpoints

MethodPathDescription
GET/api/v1/tokensList API tokens (names only — values not returned)
POST/api/v1/tokensCreate an API token
DELETE/api/v1/tokens/{id}Revoke an API token

​
Create an API token

POST /api/v1/tokens 
curl -X POST https://your-instance:3000/api/v1/tokens \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CI/CD Pipeline",
    "expiresAt": "2025-12-31T00:00:00.000Z"
  }'
​
name
string
required
A descriptive label for the token.
​
expiresAt
string (ISO 8601)
Optional expiration date. Omit for a non-expiring token.
The token value is returned only in the creation response. Store it immediately — it cannot be retrieved again.

Build docs developers (and LLMs) love

Get started for freeTalk to us