Settings API - PUT an object
Updates the specified settings object.
The request consumes and produces an application/json payload.
| PUT | Managed | 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 Write settings (settings.write) 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 |
| body | Settings | The JSON body of the request. Contains updated parameters of the settings object. | body | optional |
Request body objects
The SettingsObjectUpdate object
An update of a settings object.
| Element | Type | Description |
|---|---|---|
| schemaVersion | string | The version of the schema on which the object is based. Can be |
| 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. Can be |
| value | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{
"schemaVersion": "1.0.0",
"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"value": {
"autoMonitoring": true
}
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Settings | Success |
| 400 | Settings | Failed. Schema validation failed. |
| 403 | Error | Failed. Forbidden. |
| 404 | Settings | Failed. The requested resource doesn't exist. |
| 409 | Settings | Failed. Conflicting resource. |
Response body objects
The SettingsObjectResponse object
The response to a creation- or update-request.
| Element | Type | Description |
|---|---|---|
| invalidValue | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. Can be |
| code | integer | The HTTP status code for the object. |
| error | Error | - Can be |
| objectId | string | For a successful request, the ID of the created or modified settings object. Can be |
The Error object
| Element | Type | Description |
|---|---|---|
| constraintViolations | Constraint | A list of constraint violations Can be |
| message | string | The error message Can be |
| code | integer | The HTTP status code Can be |
The ConstraintViolation object
A list of constraint violations
| Element | Type | Description |
|---|---|---|
| parameterLocation | string | - Can be |
| location | string | - Can be |
| message | string | - Can be |
| path | string | - Can be |
Response body JSON model
{
"invalidValue": {
"autoMonitoring": true
},
"code": 1,
"error": {
"constraintViolations": [
{
"parameterLocation": "PATH",
"location": "string",
"message": "string",
"path": "string"
}
],
"message": "string",
"code": 1
},
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ="
}