• Home
  • Dynatrace API
  • Environment
  • Settings
  • Objects
  • GET objects

Settings API - GET objects

Lists settings objects that fit the specified criteria.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/settings/objects
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/objects
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects

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.

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

To load all objects belonging to the given schema IDs leave the scopes parameter empty.

queryoptional
scopesstring

A list of comma-separated scopes, that the requested objects target.

The selection only matches objects directly targeting the specified scopes. For example, environment will not match objects that target a host within environment.

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

To load all objects belonging to the given scopes leave the schemaIds parameter empty.

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, objectId,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
200ObjectsList

Success. Accessible objects returned.

403ErrorEnvelope

Failed. Forbidden.

404ErrorEnvelope

Failed. The specified schema or scope is not found.

Response body objects

The ObjectsList object

A list of settings objects.

ElementTypeDescription
itemsSettingsObject[]

A list of settings objects.

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 SettingsObject object

A settings object.

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.

updateTokenstring

The update token of the object. You can use it to detect simultaneous modifications by different users.

It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.

If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.

schemaIdstring

The schema on which the object is based.

objectIdstring

The ID of the settings object.

createdinteger

The timestamp of the creation.

scopestring

The scope that the object targets.

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", "updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", "schemaId": "builtin:container.built-in-monitoring-rule", "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", "created": 1, "scope": "HOST-D3A3C5A146830A79", "summary": "string", "value": { "autoMonitoring": true } } ], "pageSize": 1, "nextPageKey": "AQAAABQBAAAABQ==", "totalCount": 1 }