Try it free

Create a settings object

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Create a new Dynatrace settings object with the Settings API, or validate the submitted object without saving it by setting validate-only to true.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/objects

Overview

You use this operation to create a settings object from the values in the request body. Set the validate-only query parameter to true to only validate the submitted object without saving it, for example in a CI check. With the admin-access query parameter set to true and the settings:objects:admin permission, you can act on objects you don't own.

Authentication

To execute this request, you need a platform token or OAuth access token with settings:objects:write scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
admin-accessboolean

If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects

queryOptional
validate-onlyboolean

If true, the request runs only validation of the submitted settings objects, without saving them.

queryOptional
bodySettingsObjectCreate

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

bodyRequired

Request body objects

The SettingsObjectCreate object

Configuration of a new settings object.

ElementTypeDescriptionRequired
schemaIdstring

The schema on which the object is based.

Required
schemaVersionstring

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

Optional
scopestring

The scope of the settings object.

Required
externalIdstring

External id for upserts.

Optional
valueSettingsValue

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

Required
insertPositionstring-
The element can hold these values
  • first
  • last
  • after
  • before
Optional
insertNeighborstring

The position of the new object based on the objectId of the neighbor. Only for insertPosition afterand before

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.

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.

{
"schemaId": "jira-connection",
"schemaVersion": "1.0",
"scope": "environment",
"externalId": "myExternalId",
"value": {
"autoMonitoring": true
},
"insertPosition": "first",
"insertNeighbor": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ="
}

Response

Response codes

CodeTypeDescription
200SettingsObjectResponse

Existing object successfully updated.

201SettingsObjectResponse

Created.

204-

Success. No validation errors.

400--
403--
404--
409--
429--
503--
4XX--
5XX--

Response body objects

The SettingsObjectResponse object

The response to a creation request. Only contains the ID and version, not the full object.

ElementTypeDescription
objectIdstring

The ID of the created settings object.

versionstring

The version of the object for optimistic locking. You can use it to detect simultaneous modifications by different users.

It's 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.

Response body JSON models

{
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"version": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ="
}
Related tags
Platform APIDynatrace Platform