Settings API - PUT an object

Updates the specified settings object.

The request consumes and produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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 the Write settings (settings.write) permission assigned to your API token. 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 SettingsObjectUpdate

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

body optional

Body format

The SettingsObjectUpdate object

An update of a settings object.

Element Type Description Required
schemaVersion string

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

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
value SettingsValue required

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.

Response

Response codes

Code Description
200

Success

400

Failed. Schema validation failed.

404

Failed. The requested resource doesn't exist.

409

Failed. Conflicting resource.

Response body

The SettingsObjectErrorResponse object

The response to a failed settings object request

Element Type Description
invalidValue SettingsValue
error Error
code integer

The HTTP status code for the object.

The Error object

Element Type Description
constraintViolations ConstraintViolation[]

A list of constraint violations

message string

The error message

code integer

The HTTP status code

The ConstraintViolation object

A list of constraint violations

Element Type Description
parameterLocation string
location string
message string
path string

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.

Element Type Description

The SettingsObjectResponse object

The response to a successful creation or update request.

Element Type Description
objectId string

The ID of the settings object.

code integer

The HTTP status code for the object.