Skip to main content

List the published config JSON Schemas

GET 
/api/v1/checks/schema

Catalog of the generated JSON Schemas (draft 2020-12) that describe each check type's config object, with the URL of each one.

These schemas are a description, not a validator. They exist so an editor can complete a config-as-code manifest and third-party tooling can generate or lint one. SolidPing validates a config with the Go Validate() of its checker, which enforces formats, bounds and cross-field rules that reflection over a struct cannot express — a config that satisfies the schema may still be rejected. Use POST /api/v1/orgs/{org}/checks/validate (or sp checks validate) to find out whether a config is accepted; never wire a CI gate onto the JSON instead.

Responses​

The published config schemas