Try it free

Validate a settings container

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Validate a Dynatrace settings container with a custom validator using the Settings API to check a group of related values before you save them.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/values/{schema-id}:validate-container

Overview

You use the schema-id path parameter and the required validator-id query parameter to validate a settings container, a group of related values, with a custom validator of the schema. The optional scope and schema-version query parameters set the context. Typical usage is checking related fields together in a settings editor.

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

ParameterTypeDescriptionInRequired
schema-idstring

The ID of the schema.

pathRequired
scopestring

The ID of the scope.

queryOptional
validator-idstring

The identifier of the validator.

queryRequired
schema-versionstring

Version of the schema.

queryOptional
bodyCustomContainerValidationRequest

The JSON body of the request. Contains the settings object to be validated.

bodyRequired

Request body objects

The CustomContainerValidationRequest object

The request payload for a custom validation of a container.

ElementTypeDescriptionRequired
pathstring

The path of the container being validated.

Optional
keystring

The key of the setting being validated.

Optional
valueCustomContainerValidationRequestValue

The container value.

Required

The CustomContainerValidationRequestValue object

The container value.

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
"path": "string",
"key": "string",
"value": {}
}

Response

Response codes

CodeTypeDescription
200ValidationResponse

Validated. Details in the response body.

404--
429--
503--
4XX--
5XX--

Response body objects

The ValidationResponse object

ElementTypeDescription
validboolean-
messagestring-
constraintViolationsViolationResponse[]-

The ViolationResponse object

ElementTypeDescription
messagestring-
pathstring-

Response body JSON models

{
"valid": true,
"message": "string",
"constraintViolations": [
{
"message": "string",
"path": "string"
}
]
}
Related tags
Platform APIDynatrace Platform