Compose Validator
Validate Docker Compose YAML structure
API executable
Overview
ID: compose-validator
Category: data
Call this tool over HTTP with POST /execute/compose-validator. Path, headers, body fields, sample responses, and errors are documented below.
Endpoint
POST
/api/v1/execute/compose-validatorAuthenticate with X-API-Key or Authorization: Bearer. See Authentication.
API reference
Path, header, and body fields accepted by this execute call.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tool | path | string | Yes | Tool identifier used in the execute path. Example: compose-validator |
| X-API-Key | header | string | Yes | Your IT-ToolBox API key. Authorization: Bearer is also accepted. Example: YOUR_API_KEY |
| Content-Type | header | string | Yes | Must be application/json for execute requests. Example: application/json |
| input.yaml | body | string | Yes | Argument for Compose Validator. Example: services: web: image: nginx |
Code examples
shell
curl -X POST /api/v1/execute/compose-validator \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"input": {
"yaml": "services:\n web:\n image: nginx"
}
}'Tool UI
Open the interactive experience to try the tool without writing HTTP clients.
Open tool UI