config/validate
GET
/config/validateValidate 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
| Name | Type | Description |
|---|---|---|
id | string | Configuration row ID. Can address a published version or draft. |
version | integer<int32> | Published configuration version number. |
consistent | boolean | Whether to read from the primary database instead of the regional replica. Set it when reading a config straight after publishing or editing it, so the response cannot trail that write by the replica lag. |
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.
| Field | Type | Description |
|---|---|---|
validrequired | boolean | |
error_countrequired | integer<int32> | |
warning_countrequired | integer<int32> | |
issuesrequired | array of object | |
yamlrequired | string | |
source | object |
400Invalid request parameters.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
401Unauthorized.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
403Forbidden.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
404Config not found.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
500Internal server error.
| Field | Type | Description |
|---|---|---|
errorrequired | string |