Settings API - GET effective values
Lists effective settings values for the specified schemas at the specified scope.
If there are no settings objects available for the specified schema/scope combination, the request returns default values for the settings.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/effectiveValues |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/settings/effectiveValues |
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
A list of comma-separated schema IDs to which the requested objects belong.
Only considered on load of the first page, when the nextPageKey is not set.
The scope that the requested objects target.
The selection only matches objects directly targeting the specified scope. For example, environment will not match objects that target a host within environment. For more details, please see Dynatrace Documentation.
To load the first page, when the nextPageKey is not set, this parameter is required.
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, origin,value).
Supported fields: summary, searchSummary, created, modified, createdBy, modifiedBy, author, origin, schemaId, schemaVersion, value, externalId.
The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.
The first page is always returned if you don't specify the nextPageKey query parameter.
When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
The amount of settings objects in a single response payload.
The maximal allowed page size is 500.
If not set, 100 is used.
Response
Response codes
Response body objects
The EffectiveSettingsValuesList object
A list of effective settings values.
The cursor for the next page of results. Has the value of null on the last page.
Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
The number of entries per page.
The total number of entries in the result.
The EffectiveSettingsValue object
An effective settings value.
The user (identified by a user ID or a public token ID) who performed that most recent modification.
The timestamp of the creation.
The external identifier of the settings object.
The timestamp of the last modification.
The origin of the settings value.
The schema on which the object is based.
The version of the schema on which the object is based.
A searchable summary string of the setting value. Plain text without Markdown.
A short summary of settings. This can contain Markdown and will be escaped accordingly.
The value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
The AnyValue object
A schema representing an arbitrary value type.
Response body JSON model
{"items": [{"author": "john.doe@example.com","created": 1,"externalId": "string","modified": 1,"origin": "HOST-D3A3C5A146830A79","schemaId": "builtin:container.built-in-monitoring-rule","schemaVersion": "1.0.0","searchSummary": "string","summary": "string","value": "string"}],"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 1,"totalCount": 1}