Delete a Dynatrace settings object by its ID with the Settings API, using optimistic locking so that you don't remove an object someone just changed.
| DELETE | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/objects/{object-id} |
You use the object-id path parameter to delete one settings object. The required optimistic-locking-version query parameter must match the stored version, so the deletion fails if someone changed the object in the meantime. With the admin-access query parameter set to true and the settings:objects:admin permission, you can act on objects you don't own.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| object-id | string | The ID of the required settings object | path | Required |
| optimistic-locking-version | string | 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. | query | Required |
| admin-access | boolean | 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 | query | Optional |
| validate-only | boolean | If | query | Optional |
| Code | Description |
|---|---|
| 204 | Success. Response doesn't have a body. |
| 400 | - |
| 403 | - |
| 404 | - |
| 409 | - |
| 429 | - |
| 503 | - |
| 4XX | - |
| 5XX | - |