config/validate

GET/config/validate

Validate a live, published, or draft configuration using server-side account context. Requires the configuration:read permission.

Request

cURL
curl -X GET "https://provisioning.cloudx.io/api/v1/config/validate" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Query parameters

NameTypeDescription
idstringConfiguration row ID. Can address a published version or draft.
versioninteger<int32>Published configuration version number.

Responses

Config validation result.
{
  "valid": true,
  "error_count": 123,
  "warning_count": 123,
  "issues": [
    {
      "code": "<string>",
      "path": "<string>",
      "message": "<string>",
      "severity": "error",
      "line": 123,
      "column": 123,
      "length": 123
    }
  ],
  "yaml": "<string>",
  "source": {
    "type": "<string>",
    "name": "<string>"
  }
}

200Config validation result.

FieldTypeDescription
validrequiredboolean
error_countrequiredinteger<int32>
warning_countrequiredinteger<int32>
issuesrequiredarray of object
yamlrequiredstring
sourceobject

400Invalid request parameters.

FieldTypeDescription
errorrequiredstring

401Unauthorized.

FieldTypeDescription
errorrequiredstring

403Forbidden.

FieldTypeDescription
errorrequiredstring

404Config not found.

FieldTypeDescription
errorrequiredstring

500Internal server error.

FieldTypeDescription
errorrequiredstring