• Home
  • API
  • Environment
  • Settings
  • Objects
  • GET an object

Settings API - GET an object

Gets the specified settings object.

The request produces an application/json payload.

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

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
objectIdstring

The ID of the required settings object.

pathrequired

Response

Response codes

CodeTypeDescription
200SettingsObject

Success

403ErrorEnvelope

Failed. Forbidden.

404ErrorEnvelope

No object available for the given objectId

Response body objects

The SettingsObject object

A settings object.

ElementTypeDescription
authorstring

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

createdinteger

The timestamp of the creation.

createdBystring

The unique identifier of the user who created the settings object.

externalIdstring

The external identifier of the settings object.

modificationInfoModificationInfo

The modification info for a single updatable setting.

modifiedinteger

The timestamp of the last modification.

modifiedBystring

The unique identifier of the user who performed the most recent modification.

objectIdstring

The ID of the settings object.

schemaIdstring

The schema on which the object is based.

schemaVersionstring

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

scopestring

The scope that the object targets. For more details, please see Dynatrace Documentation.

searchSummarystring

A searchable summary string of the setting value. Plain text without Markdown.

summarystring

A short summary of settings. This can contain Markdown and will be escaped accordingly.

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.

valueSettingsValue

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

The ModificationInfo object

The modification info for a single updatable setting.

ElementTypeDescription
deletableboolean

If settings value can be deleted

firstboolean

If non-moveable settings value is in the first group of non-moveable settings, or in the last (start or end of list)

modifiableboolean

If settings value can be modified

modifiablePathsstring[]

Property paths which are modifiable, regardless of the state of modifiable

movableboolean

If settings value can be moved/reordered. Only applicable for ordered list schema

nonModifiablePathsstring[]

Property paths which are not modifiable, when modifiable is true

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
{ "author": "john.doe@example.com", "created": 1, "createdBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30", "externalId": "string", "modificationInfo": { "deletable": true, "first": true, "modifiable": true, "modifiablePaths": [ "string" ], "movable": true, "nonModifiablePaths": [ "string" ] }, "modified": 1, "modifiedBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30", "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", "schemaId": "builtin:container.built-in-monitoring-rule", "schemaVersion": "1.0.0", "scope": "HOST-D3A3C5A146830A79", "searchSummary": "string", "summary": "string", "updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", "value": { "autoMonitoring": true } }