Settings API - GET all schemas

Reference
Published Feb 24, 2021

Lists all settings schemas available in your environment.

The request produces an application/json payload.

GET	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas`
GET	Environment ActiveGateCluster ActiveGate	`https://{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

Parameter Type Description In Required

fields

string

Parameter	Type	Description	In	Required
fields	string	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`, `ownerBasedAccessControl`.	query	optional

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, ownerBasedAccessControl.

query

optional

Response

Response codes

Code	Type	Description
200	SchemaList	Success
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `SchemaList` object

The list of available settings schemas.

Element	Type	Description
items	SchemaStub[]	A list of settings schemas.
totalCount	integer	The number of schemas in the list.

The `SchemaStub` object

The short representation of the settings schema.

Element	Type	Description
displayName	string	The name of the schema.
latestSchemaVersion	string	The most recent version of the schema.
multiObject	boolean	Multi-object flag. `True` if the schema is a multi-object schema
ordered	boolean	Ordered flag. `True` if the schema is an ordered multi-object schema.
ownerBasedAccessControl	boolean	Owner based access control flag. `True` if the schema has owner based access control enabled.
schemaId	string	The ID of the schema.

Response body JSON model

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