Get the default value of a Dynatrace settings schema with the Settings API for a scope and schema version, for example to pre-fill a new settings form.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/values/{schema-id}/default |
You use the schema-id path parameter to get the default value of a settings schema, and the optional scope and schema-version query parameters to resolve it for a specific scope and version; without a version, the most recent one is used. Typical usage is pre-populating a form for a new settings object.
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 |
|---|---|---|---|---|
| schema-id | string | The ID of the requested schema. | path | Required |
| scope | string | The ID of the scope. | query | Optional |
| schema-version | string | The requested version of the schema. If not set, the most recent version is assumed. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Settings | Success. |
| 400 | - | - |
| 403 | - | - |
| 404 | - | - |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
SettingsDefaultObject objectThe default settings object for the given schema.
| Element | Type | Description |
|---|---|---|
| summary | string | A short summary of the object. Only set if the schema is a multi-object schema. |
| searchSummary | string | A searchable summary string of the object. Plain text without Markdown. Only set if the schema is a multi-object schema. |
| value | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. |
SettingsValue objectThe value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
{"summary": "string","searchSummary": "string","value": {"autoMonitoring": true}}