Vulnerabilities API - GET remediation item details
Lists the details of a remediation tracking process group of a third-party vulnerability (or, in the case of Kubernetes vulnerabilities, the parameters of a remediation tracking Kubernetes node).
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/securityProblems/{id}/remediationItems/{remediationItemId} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/securityProblems/{id}/remediationItems/{remediationItemId} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/securityProblems/{id}/remediationItems/{remediationItemId} |
Authentication
To execute this request, you need an access token with securityProblems.read 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 third-party security problem. | path | required |
| remediationItemId | string | The ID of the remediation item. | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Remediation | Success. The response contains details of a single remediation item of a security problem. |
Response body objects
The RemediationDetailsItem object
Detailed information of a remediation item for a security problem.
| Element | Type | Description |
|---|---|---|
| assessment | Remediation | Assessment of the remediation item. |
| entityIds | string[] | - |
| firstAffectedTimestamp | integer | - |
| id | string | - |
| muteState | Remediation | The mute state of a remediation item of a security problem. |
| name | string | - |
| remediationProgress | Remediation | The progress of this remediation item. It contains affected and unaffected entities. |
| resolvedTimestamp | integer | - |
| vulnerabilityState | string | - |
| vulnerableComponents | Remediation | A list of vulnerable components of the remediation item. A vulnerable component is what causes the security problem. |
The RemediationAssessment object
Assessment of the remediation item.
| Element | Type | Description |
|---|---|---|
| dataAssets | string | The reachability of related data assets by affected entities. |
| exposure | string | The level of exposure of affected entities. |
| numberOfDataAssets | integer | The number of related data assets. |
| vulnerableFunctionUsage | string | The usage of vulnerable functions |
| vulnerableFunctionsInUse | Vulnerable | A list of vulnerable functions that are in use. |
| vulnerableFunctionsNotAvailable | Vulnerable | A list of vulnerable functions that are not available. |
| vulnerableFunctionsNotInUse | Vulnerable | A list of vulnerable functions that are not in use. |
The VulnerableFunction object
Defines an vulnerable function.
| Element | Type | Description |
|---|---|---|
| className | string | The class name of the vulnerable function. |
| filePath | string | The file path of the vulnerable function. |
| functionName | string | The function name of the vulnerable function. |
The RemediationItemMuteState object
The mute state of a remediation item of a security problem.
| Element | Type | Description |
|---|---|---|
| comment | string | A short comment about the most recent mute state change. |
| lastUpdatedTimestamp | integer | The timestamp (UTC milliseconds) of the last update of the mute state. |
| muted | boolean | The remediation is ( |
| reason | string | The reason for the most recent mute state change. |
| user | string | The user who last changed the mute state. |
The RemediationProgress object
The progress of this remediation item. It contains affected and unaffected entities.
| Element | Type | Description |
|---|---|---|
| affectedEntities | string[] | A list of related entities that are affected by the security problem. |
| unaffectedEntities | string[] | A list of related entities that are affected by the security problem. |
The RemediationItemDetailsVulnerableComponent object
A vulnerable component with details for a remediation item (PG).
| Element | Type | Description |
|---|---|---|
| affectedEntities | string[] | A list of affected entities. |
| displayName | string | The display name of the vulnerable component. |
| fileName | string | The file name of the vulnerable component. |
| id | string | The Dynatrace entity ID of the vulnerable component. |
| loadOrigins | string[] | The load origins of the vulnerable components. |
| numberOfAffectedEntities | integer | The number of affected entities. |
| shortName | string | The short, component-only name of the vulnerable component. |
Response body JSON model
{
"assessment": {
"dataAssets": "NOT_AVAILABLE",
"exposure": "NOT_AVAILABLE",
"numberOfDataAssets": 1,
"vulnerableFunctionUsage": "IN_USE",
"vulnerableFunctionsInUse": [
{
"className": "string",
"filePath": "string",
"functionName": "string"
}
],
"vulnerableFunctionsNotAvailable": [
{}
],
"vulnerableFunctionsNotInUse": [
{}
]
},
"entityIds": [
"string"
],
"firstAffectedTimestamp": 1,
"id": "string",
"muteState": {
"comment": "string",
"lastUpdatedTimestamp": 1,
"muted": true,
"reason": "AFFECTED",
"user": "string"
},
"name": "string",
"remediationProgress": {
"affectedEntities": [
"string"
],
"unaffectedEntities": [
"string"
]
},
"resolvedTimestamp": 1,
"vulnerabilityState": "RESOLVED",
"vulnerableComponents": [
{
"affectedEntities": [
"string"
],
"displayName": "string",
"fileName": "string",
"id": "string",
"loadOrigins": [
"string"
],
"numberOfAffectedEntities": 1,
"shortName": "string"
}
]
}