Vulnerabilities API - POST mute vulnerabilities

Mutes multiple vulnerabilities. Muted vulnerabilities are hidden from the vulnerability list in Dynatrace.

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/securityProblems/mute
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/securityProblems/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
body

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

body
optional

Request body objects

The SecurityProblemsBulkMute object

Information on muting several security problems.

Element
Type
Description
Required
comment
string

A comment about the muting reason.

optional
reason
string

The reason for muting the security problems.

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

The ids of the security problems 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",
  "securityProblemIds": [
    "string"
  ]
}

Response

Response codes

Code
Type
Description
200

Success. The security problem(s) have been muted.

4XX

Client side error.

5XX

Server side error.

Response body objects

The SecurityProblemsBulkMuteResponse object

Response of muting several security problems.

Element
Type
Description
summary

The summary of which security problems were muted and which already were muted previously.

The SecurityProblemBulkMutingSummary object

Summary of (un-)muting a security problem.

Element
Type
Description
muteStateChangeTriggered
boolean

Whether a mute state change for the given security problem was triggered by this request.

reason
string

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

  • ALREADY_MUTED
  • ALREADY_UNMUTED
securityProblemId
string

The id of the security problem that was (un-)muted.

Response body JSON model

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

Example

Mute two vulnerabilities, 2919200225913269102 and 4537041069803077238, as the configuration isn't affected.

Curl

curl -X 'POST' 'https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/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 mute batch",
  "reason": "CONFIGURATION_NOT_AFFECTED",
  "securityProblemIds": [
  "2919200225913269102", "4537041069803077238"
  ]
}'

Request URL

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

Request body

{
  "comment": "Example mute batch",
  "reason": "CONFIGURATION_NOT_AFFECTED",
  "securityProblemIds": [
  "2919200225913269102", "4537041069803077238"
  ]
}

Response body

{
  "summary": [
    {
      "securityProblemId": "2919200225913269102",
      "muteStateChangeTriggered": true
    },
    {
      "securityProblemId": "4537041069803077238",
      "muteStateChangeTriggered": true
    }
  ]
}

Related topics