Dry-run validate a proposed config

Changed on
post/api/v1/admin/config/validate

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Request body

configobject required

A config.yaml deploy block, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.

providersobject

A providers.yaml document, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.

Response

Verdict {ok, errors} (even for an invalid config)

errorsstring[] required
okboolean required

Changes

  • 857732ef7bbeRevision changes
    • breaking

      added required request body

    • info

      api operation id PostConfigValidate was added

    • info

      added the non-success response with the status