Try it free

List settings schemas

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List the settings schemas available in your Dynatrace environment with the Settings API, with additional fields on request, to find schemas to work with.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/schemas

Overview

You use this operation to list every settings schema available in your environment, and the add-fields query parameter to include fields beyond the default set. A 200 response returns the schemas. Typical usage is discovering a schema ID before you read or write its settings objects.

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
add-fieldsstring

A list of fields to be included in the response. The provided set of fields extends the default set.

Specify the required top-level fields, separated by commas (for example, multiObject,ordered).

Supported fields: schemaId, displayName, latestSchemaVersion, maturity, multiObject, ordered, ownerBasedAccessControl, schemaVersions.

Default fields: schemaId, displayName, latestSchemaVersion.

queryOptional

Response

Response codes

CodeTypeDescription
200SchemaList

Success.

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

Response body objects

The SchemaList object

The list of available settings schemas.

ElementTypeDescription
itemsSchemaStub[]

A list of settings schemas.

totalCountinteger

The number of schemas in the list.

The SchemaStub object

The short representation of the settings schema.

ElementTypeDescription
displayNamestring

The name of the schema.

maturitystring

The maturity of the schema.

The element can hold these values
  • PREVIEW
  • EARLY_ADOPTER
  • GENERAL_AVAILABILITY
latestSchemaVersionstring

The most recent version of the schema.

schemaVersionsstring[]

A list of available (GA) versions of the schema.

schemaIdstring

The ID of the schema.

multiObjectboolean

Multi-object flag. True if the schema is a multi-object schema

orderedboolean

Ordered flag. True if the schema is an ordered multi-object schema.

ownerBasedAccessControlboolean

Owner based access control flag. True if the schema has owner based access control enabled.

Response body JSON models

{
"items": [
{
"displayName": "Built-in container monitoring rules",
"maturity": "GENERAL_AVAILABILITY",
"latestSchemaVersion": "1.4.2",
"schemaVersions": [
"1.4.2"
],
"schemaId": "builtin:container.built-in-monitoring-rule",
"multiObject": true,
"ordered": false,
"ownerBasedAccessControl": true
}
],
"totalCount": 1
}
Related tags
Platform APIDynatrace Platform