Settings API - GET objects
Lists settings objects that fit the specified criteria.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/objects |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/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
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.
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. For more details, please see Dynatrace Documentation.
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.
A list of comma-separated external IDs that the requested objects have.
Each external ID has a maximum length of 500 characters.
Only considered on load of the first page, when the nextPageKey is not set.
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).
Supported fields: objectId, summary, searchSummary, created, modified, createdBy, modifiedBy, author, updateToken, scope, modificationInfo (deprecated), resourceContext, owner, schemaId, schemaVersion, value, externalId.
The filter parameter, as explained here.
Filtering is supported on the following fields:
createdmodifiedcreatedBymodifiedByauthor(deprecated, will not work for future schemas)valuewith properties and sub-properties separated by dot (for example,value.owningApp = 'Notebooks')
If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 1024 characters.
Note that only fields included to the response via fields can be used for filtering.
The sort parameter, as explained here.
Sorting is supported on the following fields:
createdmodifiedcreatedBymodifiedByauthor(deprecated, will not work for future schemas)valuewith properties and sub-properties separated by dot (for example,value.owningApp)
Note that only fields included to the response via fields can be used for sorting.
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.
The amount of settings objects in a single response payload.
The maximal allowed page size is 500.
If not set, 100 is used.
Response
Response codes
Response body objects
The ObjectsList object
A list of settings objects.
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.
The number of entries per page.
The total number of entries in the result.
The SettingsObject object
A settings object.
The user (identified by a user ID or a public token ID) who performed that most recent modification.
The timestamp of the creation.
The unique identifier of the user who created the settings object.
The external identifier of the settings object.
DEPRECATED
The modification info for a single updatable setting. Replaced by resourceContext.
The timestamp of the last modification.
The unique identifier of the user who performed the most recent modification.
The ID of the settings object.
An Identity describing either a user, a group, or the all-users group (applying to all users).
The resource context, which contains additional permission information about the object.
The schema on which the object is based.
The version of the schema on which the object is based.
The scope that the object targets. For more details, please see Dynatrace Documentation.
A searchable summary string of the setting value. Plain text without Markdown.
A short summary of settings. This can contain Markdown and will be escaped accordingly.
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.
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. Replaced by resourceContext.
If settings value can be deleted
If non-moveable settings value is in the first group of non-moveable settings, or in the last (start or end of list)
If settings value can be modified
Property paths which are modifiable, regardless of the state of modifiable
If settings value can be moved/reordered. Only applicable for ordered list schema
Property paths which are not modifiable, when modifiable is true
The Identity object
An Identity describing either a user, a group, or the all-users group (applying to all users).
The user id or user group id if type is 'user' or 'group', missing if type is 'all-users'.
The type of the identity.
all-usersgroupuser
The ResourceContext object
The resource context, which contains additional permission information about the object.
The allowed operations on this settings object.
deletereadwrite
The Modification object
The additional modification details for this settings object.
If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list).
Property paths which are modifiable, regardless if the write operation is allowed.
If settings object can be moved/reordered. Only applicable for ordered list schema.
Property paths which are not modifiable, even if the write operation is allowed.
The AnyValue object
A schema representing an arbitrary value type.
Response body JSON model
{"items": [{"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=","owner": {"id": "string","type": "user"},"resourceContext": {"modifications": {"first": true,"modifiablePaths": ["string"],"movable": true,"nonModifiablePaths": ["string"]},"operations": ["delete"]},"schemaId": "builtin:container.built-in-monitoring-rule","schemaVersion": "1.0.0","scope": "HOST-D3A3C5A146830A79","searchSummary": "string","summary": "string","updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=","value": "string"}],"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 1,"totalCount": 1}