API reference
Check a configuration file
config_validate — Check a configuration document against this workspace: errors by path (unknown account handle, bad settings, unknown variable…).
config_validate · Reads saved data
Check a configuration document against this workspace: errors by path (unknown account handle, bad settings, unknown variable…). Writes nothing.
| REST | POST /api/public/v1/config/validate |
| MCP tool | config_validate |
| Permission needed | view — Owner, Manager, Operator, Viewer |
| Scope group | automation:read |
| Group | Configuration and limits |
| Shown up front in profiles | Automation |
Input
| Field | Type | Required | Description |
|---|---|---|---|
document |
object | Yes | The JSON from config_export (possibly edited, or from another workspace). |
Result
Returned in the { data, meta } envelope, without creating a job on X. Lists include next_cursor and has_more.
Example
Call over REST
curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/config/validate" \
-H "Authorization: Bearer $XBUDDY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"document":{}}'
Call over MCP
{
"method": "tools/call",
"params": {
"name": "config_validate",
"arguments": {
"document": {}
}
}
}
Errors you may get
| Code | HTTP | Retryable |
|---|---|---|
unauthorized |
401 | No |
key_expired |
401 | No |
integration_revoked |
401 | No |
connection_not_linked |
403 | No |
integration_paused |
403 | No |
workspace_integrations_paused |
403 | No |
integration_authorization_lost |
403 | No |
workspace_suspended |
403 | No |
forbidden |
403 | No |
invalid_input |
422 | No |
rate_limited |
429 | Yes |
internal |
500 | Yes |