Vulnerabilities API - POST unmute a vulnerability

  • Reference

Unmutes a specific vulnerability. Unmuted vulnerabilities are displayed on the vulnerability list in Dynatrace.

The request consumes an application/json payload.

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

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

ParameterTypeDescriptionInRequired
idstring

The ID of the requested security problem.

pathRequired
bodySecurityProblemUnmute

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

bodyOptional

Request body objects

The SecurityProblemUnmute object

Information on un-muting a security problem.

ElementTypeDescriptionRequired
commentstring

A comment about the un-muting reason.

Optional
reasonstring

The reason for un-muting a security problem.

The element can hold these values
  • AFFECTED
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": "AFFECTED"
}

Response

Response codes

CodeTypeDescription
200-

Success. The security problem has been un-muted.

204-

Not executed. The security problem is already un-muted.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
"error": {
"code": 1,
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
],
"message": "string"
}
}

Example

Unmute a vulnerability (2919200225913269102) as configuration is now affected.

Curl

curl -X 'POST' 'https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/2919200225913269102/unmute' \
-H 'accept: */*' \
-H 'Authorization: Api-Token [your_token]' \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{
"comment": "Example unmute",
"reason": "AFFECTED"
}'

Request URL

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

Request body

{
"comment": "Example unmute",
"reason": "AFFECTED"
}

Response code

200