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.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/objects |
| Environment ActiveGateCluster ActiveGate | https://{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
If true, the request runs only validation of the submitted settings objects, without saving them.
Request body objects
The RequestBody object
The SettingsObjectCreate object
Configuration of a new settings object.
External identifier for the object being created
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).
The ID of the settings object that should be replaced.
Only applicable if an external identifier is provided.
The schema on which the object is based.
The version of the schema on which the object is based.
The scope that the object targets. For more details, please see Dynatrace Documentation.
The value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
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
Multi-status: different objects in the payload resulted in different statuses.
Response body objects
The ResponseBody object
The SettingsObjectResponse object
The response to a creation- or update-request.
The HTTP status code for the object.
The value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
For a successful request, the ID of the created or modified settings object.
The Error object
The HTTP status code
The error message
The ConstraintViolation object
A list of constraint violations
HEADERPATHPAYLOAD_BODYQUERY
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="}]