Get a Dynatrace settings object by its ID with the Settings API, with additional fields on request; secret properties stay masked except for app functions.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/objects/{object-id} |
You use the object-id path parameter to read one settings object, and the add-fields query parameter to include fields beyond the default set. Properties of the secret type are returned in plain text only when the call comes from a serverless function of your app; otherwise they're masked. With the admin-access query parameter set to true and the settings:objects:admin permission, you can act on objects you don't own.
To execute this request, you need a platform token or OAuth access token with settings:objects:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| object-id | string | The ID of the required settings object | path | Required |
| add-fields | string | A list of fields to be included in the response. The provided set of fields extends the default set. Specify the required top-level fields, separated by commas (for example, summary,value). Supported fields: objectId, version, summary, searchSummary, scope, schemaId, schemaVersion, modificationInfo, resourceContext, value, owner, externalId. Default fields: objectId, version, scope, schemaId, schemaVersion, value, externalId. | query | Optional |
| admin-access | boolean | If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Settings | Success. |
| 400 | - | - |
| 403 | - | - |
| 404 | - | - |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
SettingsObject objectA settings object.
| Element | Type | Description |
|---|---|---|
| objectId | string | The ID of the settings object. |
| summary | string | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
| searchSummary | string | A searchable summary string of the setting value. Plain text without Markdown. |
| version | string | The version of the object for optimistic locking. You can use it to detect simultaneous modifications by different users. It's 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. |
| 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, see Dynatrace Documentation. |
| classicScope | string | The classic scope that the object targets. For more details, see Dynatrace Documentation. |
| modificationInfo | Modification | Modification information about the setting. |
| resourceContext | Resource | The resource context, which contains additional permission information about the object. |
| value | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. |
| owner | Identity | - |
| externalId | string | The externalId of the object. |
ModificationInfo objectModification information about the setting.
| Element | Type | Description |
|---|---|---|
| createdBy | string | The unique identifier of the user who created the setting. |
| createdTime | string | Timestamp when the setting was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| lastModifiedBy | string | The unique identifier of the user who performed the most recent modification. |
| lastModifiedTime | string | Timestamp when the setting was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| lastModifiedReason | string | The reason for the most recent modification, if available. |
ResourceContext objectThe resource context, which contains additional permission information about the object.
| Element | Type | Description |
|---|---|---|
| operations | string[] | The allowed operations on this settings object. The element can hold these values
|
| modifications | Modifications | The additional modification details for this settings object. |
Modifications objectThe additional modification details for this settings object.
| Element | Type | Description |
|---|---|---|
| first | boolean | If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list). |
| modifiablePaths | string[] | Property paths which are modifiable, regardless if the |
| movable | boolean | If settings object can be moved/reordered. Only applicable for ordered list schema. |
| nonModifiablePaths | string[] | Property paths which aren't modifiable, even if the |
SettingsValue objectThe value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
Identity object| Element | Type | Description |
|---|---|---|
| type | string | -The element can hold these values
|
| id | string | user id or user group id if type is 'user' or 'group', missing if type is 'all-users' |
{"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=","summary": "string","searchSummary": "string","version": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=","schemaId": "jira-connection","schemaVersion": "1.0.0","scope": "string","classicScope": "string","modificationInfo": {"createdBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30","createdTime": "string","lastModifiedBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30","lastModifiedTime": "string","lastModifiedReason": "string"},"resourceContext": {"operations": ["read"],"modifications": {"first": true,"modifiablePaths": ["string"],"movable": true,"nonModifiablePaths": ["string"]}},"value": {"autoMonitoring": true},"owner": {"type": "user","id": "string"},"externalId": "myExternalId"}