ToolsXpo
ToolsXpo

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 tier

Authentication

Send your API key as a bearer token. Create one free in the dashboard.

Authorization: Bearer $TOOLSXPO_KEY

Parameters

Sent as fields in the JSON body. Fields marked required must be present; everything else has a sensible default.

NameTypeDefaultDescription
playbookrequiredstring—Ansible playbook YAML to validate.
strictnessstringStrictHow strict the checks are. Strict also reports style problems, not only errors.One of: Basic, Strict
autoCorrectbooleantrueApplies 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)

FieldTypeDescription
meta.toolstringThe tool id that ran.
meta.authstringHow the call authenticated — `key` for an API key.
meta.creditsnumberEverything this call cost, in credits (both currencies together).
meta.baseCreditsnumberThe tool's own price — the compute-credit part of `credits`.
meta.aiCreditsnumberAI credits spent on a model step. Present only when non-zero.
meta.billedFromstringWhich 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.meterUnitstringMetered tools: what is counted (e.g. `megapixel`).
meta.pricing.creditsPerUnitnumberMetered tools: credits per unit counted.
meta.quota.limitnumberYour plan's allowance for the current period.
meta.quota.usednumberAllowance used so far this period.
meta.quota.remainingnumberAllowance left this period.
meta.quota.resetsAtstring (ISO 8601)When the allowance resets.
meta.quota.creditBalancenumberPurchased credits remaining, used after the allowance.
meta.quota.scopestringWhat the quota belongs to — `account` (your workspace) for API keys.
meta.quota.planstringYour plan id.

Errors

Failures use the same envelope with ok: false and a machine-readable code.

StatusCodeMeaning
400invalid_inputA parameter failed validation. `details` lists which.
401unauthorizedMissing or invalid API key.
402quota_exceededOut of credits on this workspace.
404not_foundNo such tool.
429rate_limitedToo many requests. Retry after `Retry-After` seconds.
503service_unavailableTemporarily disabled by an administrator.