Settings API - POST an object

Creates a new settings object or validates the provided settings object.

The request consumes and produces an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/objects
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/settings/objects

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
validateOnlyboolean

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 objects.

bodyoptional

Request body objects

The RequestBody object

The SettingsObjectCreate object

Configuration of a new settings object.

ElementTypeDescriptionRequired
externalIdstring

External identifier for the object being created

optional
insertAfterstring

The position of the new object. The new object will be added after the specified one.

If null, the new object will be placed in the last position.

If set to empty string, the new 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
objectIdstring

The ID of the settings object that should be replaced.

Only applicable if an external identifier is provided.

optional
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 that the object targets. For more details, please see Dynatrace Documentation.

required
valuestring

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

required

The AnyValue object

A schema representing an arbitrary value type.

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.

[
  {
    "externalId": "string",
    "insertAfter": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
    "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
    "schemaId": "builtin:container.built-in-monitoring-rule",
    "schemaVersion": "1.0.0",
    "scope": "HOST-D3A3C5A146830A79",
    "value": "string"
  }
]

Response

Response codes

CodeTypeDescription
200SettingsObjectResponse[]

Success

207SettingsObjectResponse[]

Multi-status: different objects in the payload resulted in different statuses.

400SettingsObjectResponse[]

Failed. Schema validation failed.

403ErrorEnvelope

Failed. Forbidden.

404SettingsObjectResponse[]

Failed. The requested resource doesn't exist.

409SettingsObjectResponse[]

Failed. Conflicting resource.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ResponseBody object

The SettingsObjectResponse object

The response to a creation- or update-request.

ElementTypeDescription
codeinteger

The HTTP status code for the object.

errorError-
invalidValuestring

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.

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

The AnyValue object

A schema representing an arbitrary value type.

Response body JSON model

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