Settings API - GET all schemas

Lists all settings schemas available in your environment.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/settings/schemas

Authentication

To execute this request, you need an access token with settings.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
fieldsstring

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

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

Supported fields: schemaId, displayName, latestSchemaVersion, multiObject, ordered.

queryoptional

Response

Response codes

CodeTypeDescription
200SchemaList

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

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.

latestSchemaVersionstring

The most recent version 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.

schemaIdstring

The ID of the schema.

Response body JSON model

{
  "items": [
    {
      "displayName": "Built-in container monitoring rules",
      "latestSchemaVersion": "1.4.2",
      "multiObject": true,
      "ordered": false,
      "schemaId": "builtin:container.built-in-monitoring-rule"
    }
  ],
  "totalCount": 1
}