Validate YAML validates a YAML configuration string

POST/api/v1/config/validate

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

Property	Type	Required	Description
`yamlConfig`	`string`	No

Responses

200 A successful response.

Property	Type	Description
`valid`	`boolean`
`errors`	`object[]`
`warnings`	`object[]`
`status`	`object`
`validatedAt`	`string`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/api/v1/config/validate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"yamlConfig":"string"}'

const response = await fetch("http://localhost:8089/api/v1/config/validate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "yamlConfig": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/api/v1/config/validate",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "yamlConfig": "string"
},
)
data = response.json()

Response

{
  "valid": true,
  "errors": [
    {
      "field": "string",
      "message": "string",
      "code": "string",
      "severity": "VALIDATION_SEVERITY_UNSPECIFIED"
    }
  ],
  "warnings": [
    {
      "field": "string",
      "message": "string",
      "code": "string"
    }
  ],
  "status": {
    "state": "VALIDATION_STATE_UNSPECIFIED",
    "message": "string",
    "errorCount": 0,
    "warningCount": 0,
    "lastValidated": "2024-01-01T00:00:00Z",
    "validatedSections": [
      "string"
    ],
    "failedSections": [
      "string"
    ]
  },
  "validatedAt": "2024-01-01T00:00:00Z"
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}