Security problems API - PUT mute status of a remediation item
Sets the mute status of a remediation item.
The request consumes an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| PUT | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/securityProblems/{id}/remediationItems/{itemId}/muteState |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/securityProblems/{id}/remediationItems/{itemId}/muteState | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/securityProblems/{id}/remediationItems/{itemId}/muteState |
Authentication
To execute this request, you need an access token with Write security problems (securityProblems.write) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required security problem. | path | required |
| itemId | string | The ID of the remediation item. | path | required |
| body | Remediation | The JSON body of the request. Contains the mute state information to be applied. | body | optional |
Request body objects
The RemediationItemMuteStateChange object
An updated configuration of the remediation item's mute state.
| Element | Type | Description |
|---|---|---|
| muted | boolean | The desired mute state of the remediation item. |
| reason | string | The reason for the mute state change. |
| comment | string | A comment about the mute state change reason. |
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.
{
"muted": true,
"reason": "AFFECTED",
"comment": "string"
}Response
Response codes
| Code | Description |
|---|---|
| 200 | Success. The requested mute state has been applied to the remediation item. |
| 204 | Not executed. The remediation item was previously put into the requested mute state by the same user with the same reason and comment. |
Example
In this example, the request mutes the PROCESS_GROUP-70DF2C1374244F5A remediation item of the security problem with the ID of 3_SNYK-JAVA-IONETTY-1042268 from the GET request example. The response code of 200 indicates a successful request.
The API token is passed in the Authorization header.
Curl
curl --request PUT \
--url https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/3_SNYK-JAVA-IONETTY-1042268/remediationItems/PROCESS_GROUP-70DF2C1374244F5A/muteState \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--header 'Content-Type: application/json' \
--data '{
"muted": true,
"reason": "OTHER",
"comment": "API test"
}'Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/3_SNYK-JAVA-IONETTY-1042268/remediationItems/PROCESS_GROUP-70DF2C1374244F5A/muteStateRequest body
{
"muted": true,
"reason": "OTHER",
"comment": "API test"
}Response code
200