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}

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

ID of a settings object (e.g. Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=)

path required
body UpdateObjectRequest

The request for updating the settings value

body optional

Body format

The UpdateObjectRequest object

A request to update a settings object

Element Type Description Required
updateToken string

Generated upon retrieval and can be used to detect concurrent modification when set during write operations

optional
schemaVersion string

The schema version used to create this object. If omitted the latest known version is used

optional
value SettingsValue required

The SettingsValue object

A single value to be written to the settings. Its content depends on the schema defined for this type of setting.

Response

Response codes

Code Description
200

Success

400

Schema validation failed

404

Failed. The requested resource doesn't exist.

409

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

The Error object

Element Type Description
constraintViolations ConstraintViolation[]
message string
code integer

The ConstraintViolation object

Element Type Description
parameterLocation string
location string
message string
path string

The SettingsValue object

A single value to be written to the settings. Its content depends on the schema defined for this type of setting.

Element Type Description

The SettingsObjectResponse object

The response to a successful settings object request

Element Type Description
objectId string

The identifier of the new settings object

code integer

The HTTP Status code