Get Validation Status returns the current validation status of the configuration

GET/api/v1/config/validation-status

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)

section (query)

Parameters

Name	In	Type	Required	Description
`section`	query	`string`	No	Optional: specific section to get status for

Responses

200 A successful response.

Property	Type	Description
`state`	`"VALIDATION_STATE_UNSPECIFIED" \| "VALIDATION_STATE_VALID" \| "VALIDATION_STATE_INVALID" \| "VALIDATION_STATE_WARNING" \| "VALIDATION_STATE_PARTIAL" \| "VALIDATION_STATE_PENDING" \| "VALIDATION_STATE_ERROR"`
`message`	`string`
`errorCount`	`integer`
`warningCount`	`integer`
`lastValidated`	`string`
`validatedSections`	`string[]`
`failedSections`	`string[]`

default An unexpected error response.

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

Request

curl -X GET "http://localhost:8089/api/v1/config/validation-status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/api/v1/config/validation-status", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

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

Response

{
  "state": "VALIDATION_STATE_UNSPECIFIED",
  "message": "string",
  "errorCount": 0,
  "warningCount": 0,
  "lastValidated": "2024-01-01T00:00:00Z",
  "validatedSections": [
    "string"
  ],
  "failedSections": [
    "string"
  ]
}

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