Delete a settings object in Dynatrace with the App Settings API, using optimistic locking and optional admin access to remove the stored object.
| DELETE | SaaS | https://{your-environment-id}.apps.dynatrace.com/v2/objects/{object-id} |
You provide the object ID path parameter and the required optimistic-locking-version query parameter, plus optional admin-access. The operation deletes the specified settings object and returns no response body.
To execute this request, you need a platform token or OAuth access token with app-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 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. | query | Required |
| admin-access | boolean | If set to true and user has app-settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects | query | Optional |
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |
| 403 | Error | Failed. Forbidden. |
| 404 | Error | Failed. The requested resource doesn't exist. |
| 409 | - | - |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
ErrorResponse object| Element | Type | Description |
|---|---|---|
| error | Error | Standard error response |
Error objectStandard error response
| Element | Type | Description |
|---|---|---|
| code | number | The error code (HTTP response) |
| message | string | The error message |
| retryAfterSeconds | number | Number of seconds a request can be retried after a 'too many requests' error response. |
| details | Error | Optional details of the error |
ErrorDetails objectOptional details of the error
| Element | Type | Description |
|---|---|---|
| errorRef | string | reference to the error occurrence in the internal self-monitoring, logging, etc. |
| constraintViolations | Constraint | A list of constraint violations of input parameters (path, query, request body) |
| missingScopes | string[] | In case of a 403 - Forbidden response, a list of missing scopes necessary to successfully execute the request |
ConstraintViolation objectContains information about a constraint violation caused by invalid input.
| Element | Type | Description |
|---|---|---|
| path | string | The path of the parameter that caused the constraint violation |
| message | string | The constraint violation description message |
| parameterLocation | string | Describes the general location of the violating parameter The element can hold these values
|
{"error": {"code": 1,"message": "string","retryAfterSeconds": 1,"details": {"errorRef": "string","constraintViolations": [{"path": "string","message": "string","parameterLocation": "PATH"}],"missingScopes": ["string"]}}}