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 |
|---|---|---|
| created | integer | The timestamp of the creation. |
| modified | integer | The timestamp of the last modification. |
| author | string | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
| externalId | string | The external identifier of the settings object. |
| schemaId | string | The schema on which the object is based. |
| scope | string | The scope that the object targets. |
| value | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. |
| objectId | string | The ID of the settings object. |
| schemaVersion | string | The version of the schema on which the object is based. |
| 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. |
| 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. |
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
{
"created": 1,
"modified": 1,
"author": "john.doe@example.com",
"externalId": "string",
"schemaId": "builtin:container.built-in-monitoring-rule",
"scope": "HOST-D3A3C5A146830A79",
"value": {
"autoMonitoring": true
},
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"schemaVersion": "1.0.0",
"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"searchSummary": "string",
"summary": "string"
}