• Home
  • Dynatrace API
  • Environment
  • Settings
  • Objects
  • PUT an object

Settings API - PUT an object

Updates the specified settings object.

The request consumes and produces an application/json payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/objects/{objectId}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}

Authentication

To execute this request, you need an access token with settings.write scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
objectIdstring

The ID of the required settings object.

pathrequired
bodySettingsObjectUpdate

The JSON body of the request. Contains updated parameters of the settings object.

bodyoptional

Request body objects

The SettingsObjectUpdate object

An update of a settings object.

ElementTypeDescriptionRequired
valueSettingsValue

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

required
schemaVersionstring

The version of the schema on which the object is based.

optional
updateTokenstring

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
insertAfterstring

The position of the updated object. The new object will be moved behind the specified one.

insertAfter and insertBefore are evaluated together and only one of both can be set.

If null and insertBefore 'null', the existing object keeps the current position.

If set to empty string, the updated object will be placed in the first position.

Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).

optional
insertBeforestring

The position of the updated object. The new object will be moved in front of the specified one.

insertAfter and insertBefore are evaluated together and only one of both can be set.

If null and insertAfter 'null', the existing object keeps the current position.

If set to empty string, the updated object will be placed in the last position.

Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).

optional

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.

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.

json
{ "value": { "autoMonitoring": true }, "schemaVersion": "1.0.0", "updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", "insertAfter": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", "insertBefore": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=" }

Response

Response codes

CodeTypeDescription
200SettingsObjectResponse

Success

400SettingsObjectResponse

Failed. Schema validation failed.

403ErrorEnvelope

Failed. Forbidden.

404SettingsObjectResponse

Failed. The requested resource doesn't exist.

409SettingsObjectResponse

Failed. Conflicting resource.

Response body objects

The SettingsObjectResponse object

The response to a creation- or update-request.

ElementTypeDescription
invalidValueSettingsValue

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

objectIdstring

For a successful request, the ID of the created or modified settings object.

codeinteger

The HTTP status code for the object.

errorError-

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.

The Error object

ElementTypeDescription
constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

codeinteger

The HTTP status code

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
locationstring-
messagestring-
pathstring-

Response body JSON model

json
{ "invalidValue": { "autoMonitoring": true }, "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", "code": 1, "error": { "constraintViolations": [ { "parameterLocation": "HEADER", "location": "string", "message": "string", "path": "string" } ], "message": "string", "code": 1 } }