Get a settings schema

Latest Dynatrace
Reference
Published Oct 13, 2026

Get the definition of a Dynatrace settings schema with the Settings API by its ID, in the most recent version or a specific version you request.


GET	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/schemas/{schema-id}`

Overview

You use the schema-id path parameter to read the definition of one settings schema, including its structure, constraints, and properties. The optional schema-version query parameter selects a specific version; without it, the most recent version is returned. A 200 response returns the schema definition.

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

Parameter	Type	Description	In	Required
schema-id	string	The ID of the required schema.	path	Required
schema-version	string	The version of the required schema. If not set, the most recent version is returned.	query	Optional

Parameter

Type

Description

Required

schema-id

string

The ID of the required schema.

path

Required

schema-version

string

The version of the required schema.

If not set, the most recent version is returned.

query

Optional

Response

Response codes

Code	Type	Description
200	SettingsSchemaDefinition	Success.
404	-	-
429	-	-
503	-	-
4XX	-	-
5XX	-	-

Response body objects

The `SettingsSchemaDefinition` object

Element	Type	Description
allowedScopes	string[]	A list of scopes where the schema can be used.
constraints	(ContainerConstraint \| SecretResubmissionContainerConstraint)[]	A list of constrains limiting the values to be accepted by the schema.
deletionConstraints	(CustomDeletionValidatorReferenceConstraint \| ReferentialIntegrityDeletionConstraint)[]	Constraints limiting the values to be deleted.
description	string	A short description of the schema.
displayName	string	The display name of the schema.
documentation	string	An extended description of the schema and/or links to documentation.
dynatrace	string	The version of the data format.
enums	object	A list of definitions of enum properties.
keyProperty	string	Name of the key property in this schema.
maturity	string	The maturity of the schema. Possible values: PREVIEW: Preview features aren't generally available, but might be available in specific environments as part of early-access programs. These are the most likely to change in incompatible ways. EARLY_ADOPTER: Features marked "early adopter" are available in all environments, but aren't mature enough to warrant the "general availability" designation. We don't expect incompatible changes for these, but be aware, that these aren't fully stable yet and incompatible changes may be necessary in rare cases. GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner. In any case, automations should make use of the `schemaVersion` field when writing settings objects. The element can hold these values `EARLY_ADOPTER` `GENERAL_AVAILABILITY` `PREVIEW`
maxObjects	integer	The maximum amount of objects per scope. Only applicable when multiObject is set to `true`.
metadata	object	Metadata of the setting.
multiObject	boolean	Multiple (`true`) objects per scope are permitted or a single (`false`) object per scope is permitted.
ordered	boolean	If `true` the order of objects has semantic significance. Only applicable when multiObject is set to `true`.
properties	object	A list of schema's properties.
schemaConstraints	SchemaConstraint[]	Constraints limiting the values as a whole to be accepted in this configuration element.
schemaGroups	string[]	Names of the groups, which the schema belongs to.
schemaId	string	The ID of the schema.
types	object	A list of definitions of types. A type is a complex property that contains its own set of subproperties.
version	string	The version of the schema.

The `ContainerConstraint` object

The `BiComparableContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `GREATER_THAN` `GREATER_THAN_OR_EQUAL` `LESS_THAN` `LESS_THAN_OR_EQUAL`
properties	string[]	For `type` in [`GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`] exactly two properties are required.

The `CustomValidatorReferenceContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF`
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF`.
skipAsyncValidation	boolean	`false` - validate on every change in the UI, `true` - validate only on save
timeout	integer	For `type` = `CUSTOM_VALIDATOR_REF`. Default is 5 s.

The `PropertyCountRangeContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `PROPERTY_COUNT_RANGE`
properties	string[]	For `type` in [for `type` = `PROPERTY_COUNT_RANGE` an arbitrary number of properties can be given.
minimumPropertyCount	integer	For `type` = `PROPERTY_COUNT_RANGE`.
maximumPropertyCount	integer	For `type` = `PROPERTY_COUNT_RANGE`.

The `SecretResubmissionContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `SECRET_RESUBMISSION`
checkAllProperties	boolean	Either all properties or only those marked with `forceSecretResubmission` are considered.

The `CustomDeletionValidatorReferenceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF`
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF`

The `ReferentialIntegrityDeletionConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
schemaIds	string[]	For `type` = `REFERENTIAL_INTEGRITY`
type	string	Type also defines which properties are available. The element can hold these values `REFERENTIAL_INTEGRITY`

The `EnumType` object

Element	Type	Description
type	string	Always has to be `enum` for enum types. The element can hold these values `enum`
displayName	string	Defaults to `id` in the code-api.
description	string	Short description of what this type is used for.
documentation	string	Additional information about the type, explanation of semantics of its values.
enumClass	string	Fully-qualified name of the java enum class this enum should be mapped to.
checkForDuplicateDisplayNames	boolean	Should only be set for enums that are used in combination with a datasource (so that no duplicates are ever displayed).
items	EnumValue[]	Mapping from enum values to displayName.

The `EnumValue` object

Element	Type	Description
value	string	Persisted value for the enum item
displayName	string	The human-friendly name of the value.
description	string	The human-friendly optional description of the value.
icon	string	An optional barista icon that's displayed next to the value.
enumInstance	string	Reference to an instance of #EnumType/enumClass using Enum::name

The `Property` object

Element	Type	Description
displayName	string	Defaults to `id` in the code-api.
description	string	Short description of what this property is used for.
documentation	string	Additional information about the property, explanation of semantics of its values.
metadata	MetaData	-
type	RefPointer	Ref-pointer to ComplexType/EnumType id or enum list,set,boolean,integer,float,local_date,local_time,local_date_time,zoned_date_time,time_zone,text,secret,setting.
subType	string	Only in combination with built-in types.
datasource	Datasource	-
referencedType	string	Mandatory for `setting` type, otherwise only optionally used in conjunction with subType.
items	Item	-
nullable	boolean	Defaults to `false`. Can't be `true` for properties with type `list` and `set`.
default	-	Mandatory if `nullable` = `false`, can't be set if `nullable` = `true`. Can't be empty for enum properties.
minObjects	integer	Optional.
maxObjects	integer	Defaults to `100` for collections and `1` for non-collections.
constraints	(Constraint \| CollectionConstraint)[]	Validation constraints the property value must fulfill to be persistable.
precondition	RecursivePrecondition \| NotPrecondition \| EqualsPrecondition \| InPrecondition \| NullPrecondition \| RegexMatchPrecondition	-
modificationPolicy	string	`DEFAULT` - modifiability of the value is defined by ModificationFlags.isModifiable, `ALWAYS`/`NEVER` - the value can be always/never modified. Defaults to `DEFAULT`. Can't be used on properties inside a collection property. The element can hold these values `DEFAULT` `ALWAYS` `NEVER`
forceSecretResubmission	boolean	If `true` any change to the property value also requires all properties of type `secret` to be provided
migrationPattern	string	-

The `MetaData` object

The `RefPointer` object

Element	Type	Description
$ref	string	-

The `Datasource` object

Element	Type	Description
identifier	string	-
filterProperties	string[]	-
resetValue	string	Hint to the UI to reset value when one of the filter properties changed The element can hold these values `ALWAYS` `NEVER` `INVALID_ONLY`
validate	boolean	-
fullContext	boolean	-
useApiSearch	boolean	This should be used for datasources that have scaling amounts of options, or exceptionally many.

The `Item` object

Element	Type	Description
displayName	string	The human-friendly name of the list/set item.
description	string	Short description of what this list/set item is used for.
documentation	string	Additional information about the list/set item, explanation of semantics of its values.
type	RefPointer	Ref-pointer to ComplexType/EnumType id or enum boolean,integer,float,local_date,local_time,local_date_time,zoned_date_time,time_zone,text,secret,setting
subType	string	Only in combination with built-in and enum types.
datasource	Datasource	-
referencedType	string	Mandatory for `setting` type, otherwise only optionally used in conjunction with subType.
constraints	Constraint[]	Validation constraints the list/set item value must fulfill to be persistable.
metadata	MetaData	-

The `Constraint` object

The `LengthConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `LENGTH`
maxLength	integer	For `type` = `LENGTH` and string values.
minLength	integer	For `type` = `LENGTH` and string values.

The `RangeConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `RANGE`
maximum	-	For `type` = `RANGE` and integer and floating-point numeric values.
minimum	-	For `type` = `RANGE` and integer and floating-point numeric values.

The `NotBlankConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `NOT_BLANK`

The `NotEmptyConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `NOT_EMPTY`

The `TrimmedConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `TRIMMED`

The `NoWhitespaceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `NO_WHITESPACE`

The `RegexConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `REGEX`
disallowDangerousRegex	boolean	`true` - regex must be safe, `false` - unsafe regexes are allowed

The `PatternConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `PATTERN`
pattern	string	For `type` = `PATTERN` and string values.

The `CustomValidatorReferenceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF`
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF`.
skipAsyncValidation	boolean	`false` - validate on every change in the UI, `true` - validate only on save
timeout	integer	For `type` = `CUSTOM_VALIDATOR_REF`. Default is 5 s.

The `CollectionConstraint` object

The `UniquePropertiesConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `UNIQUE`
uniqueProperties	string[]	For `type` = `UNIQUE`.

The `Precondition` object

The `RecursivePrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `AND` `OR`
preconditions	Precondition[]	For `type` in [`AND`, `OR`].

The `NotPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `NOT`
precondition	RecursivePrecondition \| NotPrecondition \| EqualsPrecondition \| InPrecondition \| NullPrecondition \| RegexMatchPrecondition	-

The `EqualsPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `EQUALS`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].
expectedValue	-	For `type` = `EQUALS`, type of value should match type of referenced property.

The `InPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `IN`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].
expectedValues	-	For `type` = `IN`, type of values should match type of referenced property.

The `NullPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `NULL`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].

The `RegexMatchPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `REGEX_MATCH`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].
pattern	string	For `type` = `REGEX_MATCH`, type of value should be string.

The `SchemaConstraint` object

The `UniqueSchemaPropertiesConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `UNIQUE`
uniqueProperties	string[]	For `type` = `UNIQUE`
flattenCollections	boolean	For `type` = `UNIQUE`

The `UniqueMultiScopeSchemaPropertiesConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `MULTI_SCOPE_UNIQUE`
uniqueProperties	string[]	For `type` = `MULTI_SCOPE_UNIQUE`

The `CustomSchemaValidatorReferenceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF` `MULTI_SCOPE_CUSTOM_VALIDATOR_REF`
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF` or `MULTI_SCOPE_CUSTOM_VALIDATOR_REF`.
skipAsyncValidation	boolean	`false` - validate on every change in the UI, `true` - validate only on save

The `ByteSizeLimitConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `BYTE_SIZE_LIMIT`
byteLimit	integer	For `type` = `BYTE_SIZE_LIMIT`

The `ComplexType` object

Element	Type	Description
type	string	Always has to be `object` for complex types. The element can hold these values `object`
version	string	Semantic version `x.y.z`, defaults to `0`, has to be increased when properties are added/removed or structurally modified (type, nullable).
versionInfo	string	Defaults to empty string.
displayName	string	Defaults to `id` in the code-api.
description	string	Short description of what this type is used for.
documentation	string	Additional information about the type, explanation of semantics of its values.
summaryPattern	string	Defaults to empty string. Markdown symbols need to be escaped if they're to be displayed normally.
searchPattern	string	If not specified the summaryPattern is used for search.
properties	object	Order is relevant for UI, not for serialization.
constraints	ContainerConstraint[]	Container validation constraints the type values must fulfill to be persistable.

Response body JSON models

{
  "allowedScopes": [
    "host",
    "application"
  ],
  "constraints": [
    {
      "customMessage": "string",
      "type": "GREATER_THAN",
      "properties": [
        "string"
      ]
    }
  ],
  "deletionConstraints": [
    {
      "customMessage": "string",
      "customValidatorId": "string",
      "type": "CUSTOM_VALIDATOR_REF"
    }
  ],
  "description": "Dynatrace disables monitoring of containers that do not run any applications",
  "displayName": "Built-in container monitoring rules",
  "documentation": "string",
  "dynatrace": "1",
  "enums": {},
  "keyProperty": "keyProperty",
  "maturity": "GENERAL_AVAILABILITY",
  "maxObjects": 10,
  "metadata": {},
  "multiObject": true,
  "ordered": true,
  "properties": {},
  "schemaConstraints": [
    {
      "customMessage": "string",
      "type": "UNIQUE",
      "uniqueProperties": [
        "string"
      ],
      "flattenCollections": false
    }
  ],
  "schemaGroups": [
    "group:some.1",
    "group:some.2"
  ],
  "schemaId": "builtin:container.built-in-monitoring-rule",
  "types": {},
  "version": "1.4.2"
}

Get a settings schema

Latest Dynatrace
Reference
Published Oct 13, 2026

Get the definition of a Dynatrace settings schema with the Settings API by its ID, in the most recent version or a specific version you request.


GET	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/schemas/{schema-id}`

Overview

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

Parameter	Type	Description	In	Required
schema-id	string	The ID of the required schema.	path	Required
schema-version	string	The version of the required schema. If not set, the most recent version is returned.	query	Optional

Parameter

Type

Description

Required

schema-id

string

The ID of the required schema.

path

Required

schema-version

string

The version of the required schema.

If not set, the most recent version is returned.

query

Optional

Response

Response codes

Code	Type	Description
200	SettingsSchemaDefinition	Success.
404	-	-
429	-	-
503	-	-
4XX	-	-
5XX	-	-

Response body objects

The `SettingsSchemaDefinition` object

Element	Type	Description
allowedScopes	string[]	A list of scopes where the schema can be used.
constraints	(ContainerConstraint \| SecretResubmissionContainerConstraint)[]	A list of constrains limiting the values to be accepted by the schema.
deletionConstraints	(CustomDeletionValidatorReferenceConstraint \| ReferentialIntegrityDeletionConstraint)[]	Constraints limiting the values to be deleted.
description	string	A short description of the schema.
displayName	string	The display name of the schema.
documentation	string	An extended description of the schema and/or links to documentation.
dynatrace	string	The version of the data format.
enums	object	A list of definitions of enum properties.
keyProperty	string	Name of the key property in this schema.
maturity	string	The maturity of the schema. Possible values: PREVIEW: Preview features aren't generally available, but might be available in specific environments as part of early-access programs. These are the most likely to change in incompatible ways. EARLY_ADOPTER: Features marked "early adopter" are available in all environments, but aren't mature enough to warrant the "general availability" designation. We don't expect incompatible changes for these, but be aware, that these aren't fully stable yet and incompatible changes may be necessary in rare cases. GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner. In any case, automations should make use of the `schemaVersion` field when writing settings objects. The element can hold these values `EARLY_ADOPTER` `GENERAL_AVAILABILITY` `PREVIEW`
maxObjects	integer	The maximum amount of objects per scope. Only applicable when multiObject is set to `true`.
metadata	object	Metadata of the setting.
multiObject	boolean	Multiple (`true`) objects per scope are permitted or a single (`false`) object per scope is permitted.
ordered	boolean	If `true` the order of objects has semantic significance. Only applicable when multiObject is set to `true`.
properties	object	A list of schema's properties.
schemaConstraints	SchemaConstraint[]	Constraints limiting the values as a whole to be accepted in this configuration element.
schemaGroups	string[]	Names of the groups, which the schema belongs to.
schemaId	string	The ID of the schema.
types	object	A list of definitions of types. A type is a complex property that contains its own set of subproperties.
version	string	The version of the schema.

The `ContainerConstraint` object

The `BiComparableContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `GREATER_THAN` `GREATER_THAN_OR_EQUAL` `LESS_THAN` `LESS_THAN_OR_EQUAL`
properties	string[]	For `type` in [`GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`] exactly two properties are required.

The `CustomValidatorReferenceContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF`
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF`.
skipAsyncValidation	boolean	`false` - validate on every change in the UI, `true` - validate only on save
timeout	integer	For `type` = `CUSTOM_VALIDATOR_REF`. Default is 5 s.

The `PropertyCountRangeContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `PROPERTY_COUNT_RANGE`
properties	string[]	For `type` in [for `type` = `PROPERTY_COUNT_RANGE` an arbitrary number of properties can be given.
minimumPropertyCount	integer	For `type` = `PROPERTY_COUNT_RANGE`.
maximumPropertyCount	integer	For `type` = `PROPERTY_COUNT_RANGE`.

The `SecretResubmissionContainerConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `SECRET_RESUBMISSION`
checkAllProperties	boolean	Either all properties or only those marked with `forceSecretResubmission` are considered.

The `CustomDeletionValidatorReferenceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF`
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF`

The `ReferentialIntegrityDeletionConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
schemaIds	string[]	For `type` = `REFERENTIAL_INTEGRITY`
type	string	Type also defines which properties are available. The element can hold these values `REFERENTIAL_INTEGRITY`

The `EnumType` object

Element	Type	Description
type	string	Always has to be `enum` for enum types. The element can hold these values `enum`
displayName	string	Defaults to `id` in the code-api.
description	string	Short description of what this type is used for.
documentation	string	Additional information about the type, explanation of semantics of its values.
enumClass	string	Fully-qualified name of the java enum class this enum should be mapped to.
checkForDuplicateDisplayNames	boolean	Should only be set for enums that are used in combination with a datasource (so that no duplicates are ever displayed).
items	EnumValue[]	Mapping from enum values to displayName.

The `EnumValue` object

Element	Type	Description
value	string	Persisted value for the enum item
displayName	string	The human-friendly name of the value.
description	string	The human-friendly optional description of the value.
icon	string	An optional barista icon that's displayed next to the value.
enumInstance	string	Reference to an instance of #EnumType/enumClass using Enum::name

The `Property` object

Element	Type	Description
displayName	string	Defaults to `id` in the code-api.
description	string	Short description of what this property is used for.
documentation	string	Additional information about the property, explanation of semantics of its values.
metadata	MetaData	-
type	RefPointer	Ref-pointer to ComplexType/EnumType id or enum list,set,boolean,integer,float,local_date,local_time,local_date_time,zoned_date_time,time_zone,text,secret,setting.
subType	string	Only in combination with built-in types.
datasource	Datasource	-
referencedType	string	Mandatory for `setting` type, otherwise only optionally used in conjunction with subType.
items	Item	-
nullable	boolean	Defaults to `false`. Can't be `true` for properties with type `list` and `set`.
default	-	Mandatory if `nullable` = `false`, can't be set if `nullable` = `true`. Can't be empty for enum properties.
minObjects	integer	Optional.
maxObjects	integer	Defaults to `100` for collections and `1` for non-collections.
constraints	(Constraint \| CollectionConstraint)[]	Validation constraints the property value must fulfill to be persistable.
precondition	RecursivePrecondition \| NotPrecondition \| EqualsPrecondition \| InPrecondition \| NullPrecondition \| RegexMatchPrecondition	-
modificationPolicy	string	`DEFAULT` - modifiability of the value is defined by ModificationFlags.isModifiable, `ALWAYS`/`NEVER` - the value can be always/never modified. Defaults to `DEFAULT`. Can't be used on properties inside a collection property. The element can hold these values `DEFAULT` `ALWAYS` `NEVER`
forceSecretResubmission	boolean	If `true` any change to the property value also requires all properties of type `secret` to be provided
migrationPattern	string	-

The `MetaData` object

The `RefPointer` object

Element	Type	Description
$ref	string	-

The `Datasource` object

Element	Type	Description
identifier	string	-
filterProperties	string[]	-
resetValue	string	Hint to the UI to reset value when one of the filter properties changed The element can hold these values `ALWAYS` `NEVER` `INVALID_ONLY`
validate	boolean	-
fullContext	boolean	-
useApiSearch	boolean	This should be used for datasources that have scaling amounts of options, or exceptionally many.

The `Item` object

Element	Type	Description
displayName	string	The human-friendly name of the list/set item.
description	string	Short description of what this list/set item is used for.
documentation	string	Additional information about the list/set item, explanation of semantics of its values.
type	RefPointer	Ref-pointer to ComplexType/EnumType id or enum boolean,integer,float,local_date,local_time,local_date_time,zoned_date_time,time_zone,text,secret,setting
subType	string	Only in combination with built-in and enum types.
datasource	Datasource	-
referencedType	string	Mandatory for `setting` type, otherwise only optionally used in conjunction with subType.
constraints	Constraint[]	Validation constraints the list/set item value must fulfill to be persistable.
metadata	MetaData	-

The `Constraint` object

The `LengthConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `LENGTH`
maxLength	integer	For `type` = `LENGTH` and string values.
minLength	integer	For `type` = `LENGTH` and string values.

The `RangeConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `RANGE`
maximum	-	For `type` = `RANGE` and integer and floating-point numeric values.
minimum	-	For `type` = `RANGE` and integer and floating-point numeric values.

The `NotBlankConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `NOT_BLANK`

The `NotEmptyConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `NOT_EMPTY`

The `TrimmedConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `TRIMMED`

The `NoWhitespaceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `NO_WHITESPACE`

The `RegexConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `REGEX`
disallowDangerousRegex	boolean	`true` - regex must be safe, `false` - unsafe regexes are allowed

The `PatternConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `PATTERN`
pattern	string	For `type` = `PATTERN` and string values.

The `CustomValidatorReferenceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF`
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF`.
skipAsyncValidation	boolean	`false` - validate on every change in the UI, `true` - validate only on save
timeout	integer	For `type` = `CUSTOM_VALIDATOR_REF`. Default is 5 s.

The `CollectionConstraint` object

The `UniquePropertiesConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `UNIQUE`
uniqueProperties	string[]	For `type` = `UNIQUE`.

The `Precondition` object

The `RecursivePrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `AND` `OR`
preconditions	Precondition[]	For `type` in [`AND`, `OR`].

The `NotPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `NOT`
precondition	RecursivePrecondition \| NotPrecondition \| EqualsPrecondition \| InPrecondition \| NullPrecondition \| RegexMatchPrecondition	-

The `EqualsPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `EQUALS`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].
expectedValue	-	For `type` = `EQUALS`, type of value should match type of referenced property.

The `InPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `IN`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].
expectedValues	-	For `type` = `IN`, type of values should match type of referenced property.

The `NullPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `NULL`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].

The `RegexMatchPrecondition` object

Element	Type	Description
type	string	Type also defines which properties are required. The element can hold these values `REGEX_MATCH`
property	string	For `type` in [`NULL`, `EQUALS`, `IN`, `REGEX_MATCH`].
pattern	string	For `type` = `REGEX_MATCH`, type of value should be string.

The `SchemaConstraint` object

The `UniqueSchemaPropertiesConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `UNIQUE`
uniqueProperties	string[]	For `type` = `UNIQUE`
flattenCollections	boolean	For `type` = `UNIQUE`

The `UniqueMultiScopeSchemaPropertiesConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `MULTI_SCOPE_UNIQUE`
uniqueProperties	string[]	For `type` = `MULTI_SCOPE_UNIQUE`

The `CustomSchemaValidatorReferenceConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `CUSTOM_VALIDATOR_REF` `MULTI_SCOPE_CUSTOM_VALIDATOR_REF`
customValidatorId	string	For `type` = `CUSTOM_VALIDATOR_REF` or `MULTI_SCOPE_CUSTOM_VALIDATOR_REF`.
skipAsyncValidation	boolean	`false` - validate on every change in the UI, `true` - validate only on save

The `ByteSizeLimitConstraint` object

Element	Type	Description
customMessage	string	Message to be displayed if constraint is violated.
type	string	Type also defines which properties are available. The element can hold these values `BYTE_SIZE_LIMIT`
byteLimit	integer	For `type` = `BYTE_SIZE_LIMIT`

The `ComplexType` object

Element	Type	Description
type	string	Always has to be `object` for complex types. The element can hold these values `object`
version	string	Semantic version `x.y.z`, defaults to `0`, has to be increased when properties are added/removed or structurally modified (type, nullable).
versionInfo	string	Defaults to empty string.
displayName	string	Defaults to `id` in the code-api.
description	string	Short description of what this type is used for.
documentation	string	Additional information about the type, explanation of semantics of its values.
summaryPattern	string	Defaults to empty string. Markdown symbols need to be escaped if they're to be displayed normally.
searchPattern	string	If not specified the summaryPattern is used for search.
properties	object	Order is relevant for UI, not for serialization.
constraints	ContainerConstraint[]	Container validation constraints the type values must fulfill to be persistable.

Response body JSON models

{
  "allowedScopes": [
    "host",
    "application"
  ],
  "constraints": [
    {
      "customMessage": "string",
      "type": "GREATER_THAN",
      "properties": [
        "string"
      ]
    }
  ],
  "deletionConstraints": [
    {
      "customMessage": "string",
      "customValidatorId": "string",
      "type": "CUSTOM_VALIDATOR_REF"
    }
  ],
  "description": "Dynatrace disables monitoring of containers that do not run any applications",
  "displayName": "Built-in container monitoring rules",
  "documentation": "string",
  "dynatrace": "1",
  "enums": {},
  "keyProperty": "keyProperty",
  "maturity": "GENERAL_AVAILABILITY",
  "maxObjects": 10,
  "metadata": {},
  "multiObject": true,
  "ordered": true,
  "properties": {},
  "schemaConstraints": [
    {
      "customMessage": "string",
      "type": "UNIQUE",
      "uniqueProperties": [
        "string"
      ],
      "flattenCollections": false
    }
  ],
  "schemaGroups": [
    "group:some.1",
    "group:some.2"
  ],
  "schemaId": "builtin:container.built-in-monitoring-rule",
  "types": {},
  "version": "1.4.2"
}

Get a settings schema

Overview

Authentication

Parameters

Response

Response codes

Response body objects

The SettingsSchemaDefinition object

The ContainerConstraint object

The BiComparableContainerConstraint object

The CustomValidatorReferenceContainerConstraint object

The PropertyCountRangeContainerConstraint object

The SecretResubmissionContainerConstraint object

The CustomDeletionValidatorReferenceConstraint object

The ReferentialIntegrityDeletionConstraint object

The EnumType object

The EnumValue object

The Property object

The MetaData object

The RefPointer object

The Datasource object

The Item object

The Constraint object

The LengthConstraint object

The RangeConstraint object

The NotBlankConstraint object

The NotEmptyConstraint object

The TrimmedConstraint object

The NoWhitespaceConstraint object

The RegexConstraint object

The PatternConstraint object

The CustomValidatorReferenceConstraint object

The CollectionConstraint object

The UniquePropertiesConstraint object

The Precondition object

The RecursivePrecondition object

The NotPrecondition object

The EqualsPrecondition object

The InPrecondition object

The NullPrecondition object

The RegexMatchPrecondition object

The SchemaConstraint object

The UniqueSchemaPropertiesConstraint object

The UniqueMultiScopeSchemaPropertiesConstraint object

The CustomSchemaValidatorReferenceConstraint object

The ByteSizeLimitConstraint object

The ComplexType object

Response body JSON models

Get a settings schema

Overview

Authentication

Parameters

Response

Response codes

Response body objects

The SettingsSchemaDefinition object

The ContainerConstraint object

The BiComparableContainerConstraint object

The CustomValidatorReferenceContainerConstraint object

The PropertyCountRangeContainerConstraint object

The SecretResubmissionContainerConstraint object

The CustomDeletionValidatorReferenceConstraint object

The ReferentialIntegrityDeletionConstraint object

The EnumType object

The EnumValue object

The Property object

The MetaData object

The RefPointer object

The Datasource object

The Item object

The Constraint object

The LengthConstraint object

The RangeConstraint object

The NotBlankConstraint object

The NotEmptyConstraint object

The TrimmedConstraint object

The NoWhitespaceConstraint object

The RegexConstraint object

The PatternConstraint object

The CustomValidatorReferenceConstraint object

The `SettingsSchemaDefinition` object

The `ContainerConstraint` object

The `BiComparableContainerConstraint` object

The `CustomValidatorReferenceContainerConstraint` object

The `PropertyCountRangeContainerConstraint` object

The `SecretResubmissionContainerConstraint` object

The `CustomDeletionValidatorReferenceConstraint` object

The `ReferentialIntegrityDeletionConstraint` object

The `EnumType` object

The `EnumValue` object

The `Property` object

The `MetaData` object

The `RefPointer` object

The `Datasource` object

The `Item` object

The `Constraint` object

The `LengthConstraint` object

The `RangeConstraint` object

The `NotBlankConstraint` object

The `NotEmptyConstraint` object

The `TrimmedConstraint` object

The `NoWhitespaceConstraint` object

The `RegexConstraint` object

The `PatternConstraint` object

The `CustomValidatorReferenceConstraint` object

The `CollectionConstraint` object

The `UniquePropertiesConstraint` object

The `Precondition` object

The `RecursivePrecondition` object

The `NotPrecondition` object

The `EqualsPrecondition` object

The `InPrecondition` object

The `NullPrecondition` object

The `RegexMatchPrecondition` object

The `SchemaConstraint` object

The `UniqueSchemaPropertiesConstraint` object

The `UniqueMultiScopeSchemaPropertiesConstraint` object

The `CustomSchemaValidatorReferenceConstraint` object

The `ByteSizeLimitConstraint` object

The `ComplexType` object

The `SettingsSchemaDefinition` object

The `ContainerConstraint` object

The `BiComparableContainerConstraint` object

The `CustomValidatorReferenceContainerConstraint` object

The `PropertyCountRangeContainerConstraint` object

The `SecretResubmissionContainerConstraint` object

The `CustomDeletionValidatorReferenceConstraint` object

The `ReferentialIntegrityDeletionConstraint` object

The `EnumType` object

The `EnumValue` object

The `Property` object

The `MetaData` object

The `RefPointer` object

The `Datasource` object

The `Item` object

The `Constraint` object

The `LengthConstraint` object

The `RangeConstraint` object

The `NotBlankConstraint` object

The `NotEmptyConstraint` object

The `TrimmedConstraint` object

The `NoWhitespaceConstraint` object

The `RegexConstraint` object

The `PatternConstraint` object

The `CustomValidatorReferenceConstraint` object

The `CollectionConstraint` object

The `UniquePropertiesConstraint` object

The `Precondition` object

The `RecursivePrecondition` object

The `NotPrecondition` object

The `EqualsPrecondition` object

The `InPrecondition` object

The `NullPrecondition` object

The `RegexMatchPrecondition` object

The `SchemaConstraint` object

The `UniqueSchemaPropertiesConstraint` object

The `UniqueMultiScopeSchemaPropertiesConstraint` object

The `CustomSchemaValidatorReferenceConstraint` object

The `ByteSizeLimitConstraint` object

The `ComplexType` object