Settings API - GET an object
Gets the specified settings object.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/objects/{objectId} | |
Environment ActiveGate | https://{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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
objectId | string | The ID of the required settings object. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Settings | Success |
403 | ErrorEnvelope | Failed. Forbidden. |
404 | ErrorEnvelope | No object available for the given objectId |
Response body objects
The SettingsObject
object
A settings object.
Element | Type | Description |
---|---|---|
author | string | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
created | integer | The timestamp of the creation. |
createdBy | string | The unique identifier of the user who created the settings object. |
externalId | string | The external identifier of the settings object. |
modificationInfo | Modification | The modification info for a single updatable setting. |
modified | integer | The timestamp of the last modification. |
modifiedBy | string | The unique identifier of the user who performed the most recent modification. |
objectId | string | The ID of the settings object. |
schemaId | string | The schema on which the object is based. |
schemaVersion | string | The version of the schema on which the object is based. |
scope | string | The scope that the object targets. For more details, please see Dynatrace Documentation. |
searchSummary | string | A searchable summary string of the setting value. Plain text without Markdown. |
summary | string | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
updateToken | string | 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. |
value | Settings | 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.
Element | Type | Description |
---|---|---|
deletable | boolean | If settings value can be deleted |
first | boolean | If non-moveable settings value is in the first group of non-moveable settings, or in the last (start or end of list) |
modifiable | boolean | If settings value can be modified |
modifiablePaths | string[] | Property paths which are modifiable, regardless of the state of |
movable | boolean | If settings value can be moved/reordered. Only applicable for ordered list schema |
nonModifiablePaths | string[] | Property paths which are not modifiable, when |
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
{
"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
}
}