Vulnerabilities API - PUT mute or unmute a remediation item
Set the mute status of a remediation tracking process group or, in the case of Kubernetes vulnerabilities, of a remediation tracking Kubernetes node, to mute
or unmute
.
The request consumes an application/json
payload.
PUT | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/securityProblems/{id}/remediationItems/{remediationItemId}/muteState |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/securityProblems/{id}/remediationItems/{remediationItemId}/muteState | |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/securityProblems/{id}/remediationItems/{remediationItemId}/muteState |
Authentication
To execute this request, you need an access token with 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 requested third-party security problem. | path | required |
remediationItemId | string | The ID of the remediation item. | path | required |
body | RemediationItemMuteStateChange | 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 | Required |
---|---|---|---|
comment | string | A comment about the mute state change reason. | required |
muted | boolean | The desired mute state of the remediation item. | required |
reason | string | The reason for the mute state change.
| required |
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.
{"comment": "string","muted": true,"reason": "IGNORE"}
Response
Response codes
Code | Type | 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. |
4XX | ErrorEnvelope | Client side error. |
5XX | ErrorEnvelope | Server side error. |
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/muteState
Request body
{"muted": true,"reason": "OTHER","comment": "API test"}
Response code
200