• Home
  • Dynatrace API
  • Environment
  • Settings
  • Objects
  • GET effective values

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/settings/effectiveValues
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/effectiveValues
Environment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
schemaIdsstring

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.

queryoptional
scopestring

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.

To load the first page, when the nextPageKey is not set, this parameter is required.

queryoptional
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, origin,value).

queryoptional
nextPageKeystring

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.

queryoptional
pageSizeinteger

The amount of settings objects in a single response payload.

The maximal allowed page size is 500.

If not set, 100 is used.

queryoptional

Response

Response codes

CodeTypeDescription
200EffectiveSettingsValuesList

Success

404ErrorEnvelope

Failed. The specified schema or scope is not found.

Response body objects

The EffectiveSettingsValuesList object

A list of effective settings values.

ElementTypeDescription
itemsEffectiveSettingsValue[]

A list of effective settings values.

pageSizeinteger

The number of entries per page.

nextPageKeystring

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.

totalCountinteger

The total number of entries in the result.

The EffectiveSettingsValue object

An effective settings value.

ElementTypeDescription
externalIdstring

The external identifier of the settings object.

authorstring

The user (identified by a user ID or a public token ID) who performed that most recent modification.

modifiedinteger

The timestamp of the last modification.

schemaVersionstring

The version of the schema on which the object is based.

schemaIdstring

The schema on which the object is based.

originstring

The origin of the settings value.

createdinteger

The timestamp of the creation.

summarystring

A short summary of settings.

valueSettingsValue

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

The SettingsValue object

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

The object doesn't provide any parameters.

Response body JSON model

json
{ "items": [ { "externalId": "string", "author": "john.doe@example.com", "modified": 1, "schemaVersion": "1.0.0", "schemaId": "builtin:container.built-in-monitoring-rule", "origin": "HOST-D3A3C5A146830A79", "created": 1, "summary": "string", "value": { "autoMonitoring": true } } ], "pageSize": 1, "nextPageKey": "AQAAABQBAAAABQ==", "totalCount": 1 }