DevOps & Config
Docker Compose Builder API
POST request to /v1/docker-compose-builder, returning text in the standard envelope.
POST
/v1/docker-compose-builder2 credits / call Free tierAuthentication
Send your API key as a bearer token. Create one free in the dashboard.
Authorization: Bearer $TOOLSXPO_KEYParameters
Sent as fields in the JSON body. The values below are the examples used throughout this page.
| Name | Example value |
|---|---|
| services | web,db |
| nginxPort | 80:80 |
| pgDb | app |
| pgUser | admin |
| pgPass | secret_password |
| nodePort | 3000:3000 |
| redisPort | 6379:6379 |
Example request
curl -X POST "https://api.toolsxpo.com/v1/docker-compose-builder" \
-H "Authorization: Bearer $TOOLSXPO_KEY" \
-H "Content-Type: application/json" \
-d '{"services":"web,db","nginxPort":"80:80","pgDb":"app","pgUser":"admin","pgPass":"secret_password","nodePort":"3000:3000","redisPort":"6379:6379"}'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. |