Settings API - GET objects
Lists settings objects that fit the specified criteria.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/objects | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects |
Authentication
To execute this request, you need Read settings (settings.read) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| schemaIds | string | A list of comma-separated schema IDs to which the requested objects belong. To load the first page, when the nextPageKey is not set, this parameter is required. | query | required |
| scopes | string | A list of comma-separated scopes, that the requested objects target. The selection only matches objects directly targeting the specified scopes. For example, To load the first page, when the nextPageKey is not set, this parameter is required. | query | required |
| fields | string | 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, | query | required |
| nextPageKey | string | 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. | query | required |
| pageSize | integer | The amount of settings objects in a single response payload. The maximal allowed page size is 500. If not set, 100 is used. | query | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Objects | Success |
| 404 | Error | Failed. The specified schema or scope is not found. |
Response body objects
The ObjectsList object
A list of settings objects.
| Element | Type | Description | Required |
|---|---|---|---|
| items | Settings | A list of settings objects. | optional |
| nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. | optional |
| totalCount | integer | The total number of entries in the result. | required |
| pageSize | integer | The number of entries per page. | optional |
The SettingsObject object
A settings object.
| Element | Type | Description | Required |
|---|---|---|---|
| modified | integer | The timestamp of the last modification. | optional |
| schemaVersion | string | The version of the schema on which the object is based. | optional |
| author | string | The user (identified by a user ID or a public token ID) who performed that most recent modification. | optional |
| 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. | optional |
| created | integer | The timestamp of the creation. | optional |
| schemaId | string | The schema on which the object is based. | optional |
| value | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. | optional |
| objectId | string | The ID of the settings object. | optional |
| scope | string | The scope that the object targets. | optional |
| summary | string | A short summary of settings. | optional |
Response body JSON model
{
"items": [
{
"modified": 1,
"schemaVersion": "1.0.0",
"author": "john.doe@example.com",
"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"created": 1,
"schemaId": "builtin:container.built-in-monitoring-rule",
"value": {
"autoMonitoring": true
},
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"scope": "HOST-D3A3C5A146830A79",
"summary": "string"
}
],
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1,
"pageSize": 1
}