Validate a settings property

• Latest Dynatrace
• Reference
• Published Oct 13, 2026

Validate a Dynatrace settings property value with a custom validator using the Settings API before you save the settings object it belongs to.

Overview

You use the schema-id path parameter and the required validator-id query parameter to validate one property value with a custom validator of the schema. The optional scope and schema-version query parameters set the context. Typical usage is validating user input in a settings editor while the user types.

Authentication

To execute this request, you need a platform token or OAuth access token with settings:schemas:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

{
  "path": "string",
  "intValue": 1,
  "floatValue": 1,
  "stringValue": "string",
  "booleanValue": true,
  "arrayValue": [
    {}
  ]
}

Response

{
  "valid": true,
  "message": "string",
  "constraintViolations": [
    {
      "message": "string",
      "path": "string"
    }
  ]
}