List the settings schemas available in your Dynatrace environment with the Settings API, with additional fields on request, to find schemas to work with.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/schemas |
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.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| add-fields | string | 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. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Schema | Success. |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
SchemaList objectThe list of available settings schemas.
| Element | Type | Description |
|---|---|---|
| items | Schema | A list of settings schemas. |
| totalCount | integer | The number of schemas in the list. |
SchemaStub objectThe short representation of the settings schema.
| Element | Type | Description |
|---|---|---|
| displayName | string | The name of the schema. |
| maturity | string | The maturity of the schema. The element can hold these values
|
| latestSchemaVersion | string | The most recent version of the schema. |
| schemaVersions | string[] | A list of available (GA) versions of the schema. |
| schemaId | string | The ID of the schema. |
| multiObject | boolean | Multi-object flag. |
| ordered | boolean | Ordered flag. |
| ownerBasedAccessControl | boolean | Owner based access control flag. |
{"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}