Settings API - DELETE an object

Updates the specified settings object. Deletion cannot be undone!

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

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
objectIdstring

The ID of the required settings object.

pathrequired
updateTokenstring

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.

queryoptional
adminAccessboolean

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

Response

Response codes

CodeTypeDescription
204-

Success. Response doesn't have a body.

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.