Vulnarabilities API - POST mute remediation items

Mutes multiple remediation tracking process groups or, in the case of Kubernetes vulnerabilities, multiple remediation tracking Kubernetes nodes.

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/securityProblems/{id}/remediationItems/mute
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/securityProblems/{id}/remediationItems/mute

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
body

The JSON body of the request. Contains the muting information.

body
optional

Request body objects

The RemediationItemsBulkMute object

Information on muting several remediation items.

Element
Type
Description
Required
comment
string

A comment about the muting reason.

optional
reason
string

The reason for muting the remediation items.

  • CONFIGURATION_NOT_AFFECTED
  • FALSE_POSITIVE
  • IGNORE
  • OTHER
  • VULNERABLE_CODE_NOT_IN_USE
required
remediationItemIds
string[]

The ids of the remediation items to be muted.

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",
  "reason": "CONFIGURATION_NOT_AFFECTED",
  "remediationItemIds": [
    "string"
  ]
}

Response

Response codes

Code
Type
Description
200

Success. The remediation item(s) have been muted.

4XX

Client side error.

5XX

Server side error.

Response body objects

The RemediationItemsBulkMuteResponse object

Response of muting several remediation items.

Element
Type
Description
summary

The summary of which remediation items were muted and which already were muted previously.

The RemediationItemMutingSummary object

Summary of (un-)muting a remediation item.

Element
Type
Description
muteStateChangeTriggered
boolean

Whether a mute state change for the given remediation item was triggered by this request.

reason
string

Contains a reason, in case the requested operation was not executed.

  • ALREADY_MUTED
  • ALREADY_UNMUTED
  • REMEDIATION_ITEM_NOT_AFFECTED_BY_GIVEN_SECURITY_PROBLEM
remediationItemId
string

The id of the remediation item that will be (un-)muted.

Response body JSON model

{
  "summary": [
    {
      "muteStateChangeTriggered": true,
      "reason": "ALREADY_MUTED",
      "remediationItemId": "string"
    }
  ]
}

Example

Mute two remediation items, PROCESS_GROUP-46C0E12D9B0EF2D9 and PROCESS_GROUP-549E6AD75BD598EC as the configuration isn't affected.

Curl

curl -X 'POST' 'https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/2919200225913269102/remediationItems/mute' \
-H 'accept: application/json; charset=utf-8' \
-H 'Authorization: Api-Token [your_token]' \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{
  "comment": "Example muting multiple entities",
  "reason": "CONFIGURATION_NOT_AFFECTED",
  "remediationItemIds": ["PROCESS_GROUP-46C0E12D9B0EF2D9", "PROCESS_GROUP-549E6AD75BD598EC"]
}'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/2919200225913269102/remediationItems/mute

Request body

{
  "comment": "Example muting multiple entities",
  "reason": "CONFIGURATION_NOT_AFFECTED",
  "remediationItemIds": ["PROCESS_GROUP-46C0E12D9B0EF2D9", "PROCESS_GROUP-549E6AD75BD598EC"]
}

Response body

{
  "summary": [
    {
      "remediationItemId": "PROCESS_GROUP-549E6AD75BD598EC",
      "muteStateChangeTriggered": true
    },
    {
      "remediationItemId": "PROCESS_GROUP-46C0E12D9B0EF2D9",
      "muteStateChangeTriggered": true
    }
  ]
}

If the request was successful, you'll see muteStateChangeTriggered per entity.

Related topics