DevOps & Config
Ansible Playbook Syntax Checker API
POST request to /v1/ansible-syntax-checker, returning json in the standard envelope.
POST
/v1/ansible-syntax-checker2 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. Fields marked required must be present; everything else has a sensible default.
| Name | Type | Default | Description |
|---|---|---|---|
| playbookrequired | string | — | Ansible playbook YAML to validate. |
| strictness | string | Strict | How strict the checks are. Strict also reports style problems, not only errors.One of: Basic, Strict |
| autoCorrect | boolean | true | Applies safe fixes and returns the corrected playbook alongside the report. |
Example request
curl -X POST "https://api.toolsxpo.com/v1/ansible-syntax-checker" \
-H "Authorization: Bearer $TOOLSXPO_KEY" \
-H "Content-Type: application/json" \
-d '{"playbook":"- hosts: web\n tasks:\n - name: Install nginx\n apt:\n name: nginx\n state: present","strictness":"Strict","autoCorrect":"true"}'Response
Every endpoint answers with the same envelope: the result in data, what the call cost and your standing in meta.
{
"ok": true,
"data": { /* json */ },
"meta": { "credits": 2 }
}meta fields (every tool)
| Field | Type | Description |
|---|---|---|
| meta.tool | string | The tool id that ran. |
| meta.auth | string | How the call authenticated — `key` for an API key. |
| meta.credits | number | Everything this call cost, in credits (both currencies together). |
| meta.baseCredits | number | The tool's own price — the compute-credit part of `credits`. |
| meta.aiCredits | number | AI credits spent on a model step. Present only when non-zero. |
| meta.billedFrom | string | Which balance paid: the plan allowance or the purchased credit balance. |
| meta.pricing.mode | "flat" | "metered" | Flat price per call, or metered by usage. |
| meta.pricing.meterUnit | string | Metered tools: what is counted (e.g. `megapixel`). |
| meta.pricing.creditsPerUnit | number | Metered tools: credits per unit counted. |
| meta.quota.limit | number | Your plan's allowance for the current period. |
| meta.quota.used | number | Allowance used so far this period. |
| meta.quota.remaining | number | Allowance left this period. |
| meta.quota.resetsAt | string (ISO 8601) | When the allowance resets. |
| meta.quota.creditBalance | number | Purchased credits remaining, used after the allowance. |
| meta.quota.scope | string | What the quota belongs to — `account` (your workspace) for API keys. |
| meta.quota.plan | string | Your plan id. |
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. |