DevOps & Config
Caddyfile Configuration Generator API
GET request to /v1/caddyfile-generator, returning text in the standard envelope.
GET
/v1/caddyfile-generator2 credits / call Free tierAuthentication
Send your API key as a bearer token. Create one free in the dashboard.
Authorization: Bearer $TOOLSXPO_KEYParameters
Sent as query-string parameters. The values below are the examples used throughout this page.
| Name | Example value |
|---|---|
| siteMode | reverse-proxy |
| domain | app.example.com |
| ops@example.com | |
| rootPath | /srv/www/app |
| upstream | 127.0.0.1:3000 |
| enableCompression | true |
| enableSecurityHeaders | true |
| enableSpaFallback | false |
Example request
curl "https://api.toolsxpo.com/v1/caddyfile-generator?siteMode=reverse-proxy&domain=app.example.com&email=ops%40example.com&rootPath=%2Fsrv%2Fwww%2Fapp&upstream=127.0.0.1%3A3000&enableCompression=true&enableSecurityHeaders=true&enableSpaFallback=false" \
-H "Authorization: Bearer $TOOLSXPO_KEY"Response
Every endpoint answers with the same envelope. The result is in data (text); meta.credits reports what the call cost.
{
"ok": true,
"data": { /* text */ },
"meta": { "credits": 2 }
}Errors
Failures use the same envelope with ok: false and a machine-readable code.
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_input | A parameter failed validation. `details` lists which. |
| 401 | unauthorized | Missing or invalid API key. |
| 402 | quota_exceeded | Out of credits on this workspace. |
| 404 | not_found | No such tool. |
| 429 | rate_limited | Too many requests. Retry after `Retry-After` seconds. |
| 503 | service_unavailable | Temporarily disabled by an administrator. |