Vulnerabilities API - GET remediation item entities

Lists the remediation tracking processes of a third-party vulnerability.

The request produces an application/json payload.

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

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

ParameterTypeDescriptionInRequired
idstring

The ID of the requested third-party security problem.

pathrequired
remediationItemIdstring

The ID of the remediation item.

pathrequired
remediationProgressEntitySelectorstring

Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.

You can add one or more of the following criteria. Values are not case-sensitive and the EQUALS operator is used unless otherwise specified.

  • State: state("value"). Possible values the state field are AFFECTED and UNAFFECTED. If not set, all entities are returned.
  • Vulnerable function usage assessment: assessment.vulnerableFunctionUsage("value") Possible values are IN_USE, and NOT_IN_USE.
  • Vulnerable function restart required: assessment.vulnerableFunctionRestartRequired("value") Possible values are TRUE or FALSE.
  • Vulnerable function in use contains: assessment.vulnerableFunctionInUseContains("value"). Possible values are class::function, class:: and function. The CONTAINS operator is used. Only vulnerable functions in use are considered.
  • Entity name contains: entityNameContains("value-1"). The CONTAINS operator is used.

To set several criteria, separate them with a comma (,). Only results matching all criteria are included in the response.

Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (~) inside quotes:

  • Tilde ~
  • Quote "
queryoptional

Response

Response codes

CodeTypeDescription
200RemediationProgressEntityList

Success. The response contains a list of remediation progress entities of a remediation item of a security problem. The number of entities returned is limited.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The RemediationProgressEntityList object

A list of remediation progress entities.

ElementTypeDescription
remediationProgressEntitiesRemediationProgressEntity[]

A list of remediation progress entities.

The RemediationProgressEntity object

An affected or unaffected entity of a remediation for a security problem.

ElementTypeDescription
assessmentRemediationProgressEntityAssessment

Assessment of the remediation progress entity.

firstAffectedTimestampinteger

The timestamp when the remediation progress entity has first been related to the vulnerability.

idstring

The ID of the remediation progress entity.

namestring

The name of the remediation progress entity.

statestring

The current state of the remediation progress entity.

  • AFFECTED
  • UNAFFECTED
vulnerableComponentsRemediationProgressVulnerableComponent[]

A list of vulnerable components of the remediation item.

A vulnerable component is what causes the security problem.

The RemediationProgressEntityAssessment object

Assessment of the remediation progress entity.

ElementTypeDescription
vulnerableFunctionRestartRequiredboolean

Whether a restart is required for the latest vulnerable function data.

vulnerableFunctionUsagestring

The usage of vulnerable functions

  • IN_USE
  • NOT_AVAILABLE
  • NOT_IN_USE
vulnerableFunctionsInUseVulnerableFunction[]

A list of vulnerable functions that are in use.

vulnerableFunctionsNotAvailableVulnerableFunction[]

A list of vulnerable functions that are not available.

vulnerableFunctionsNotInUseVulnerableFunction[]

A list of vulnerable functions that are not in use.

The VulnerableFunction object

Defines an vulnerable function.

ElementTypeDescription
classNamestring

The class name of the vulnerable function.

filePathstring

The file path of the vulnerable function.

functionNamestring

The function name of the vulnerable function.

The RemediationProgressVulnerableComponent object

A vulnerable component with details for a remediation progress entity (PGI).

ElementTypeDescription
displayNamestring

The display name of the vulnerable component.

fileNamestring

The file name of the vulnerable component.

idstring

The Dynatrace entity ID of the vulnerable component.

loadOriginsstring[]

The load origins of the vulnerable components.

shortNamestring

The short, component-only name of the vulnerable component.

Response body JSON model

{
  "remediationProgressEntities": [
    {
      "assessment": {
        "vulnerableFunctionRestartRequired": true,
        "vulnerableFunctionUsage": "IN_USE",
        "vulnerableFunctionsInUse": [
          {
            "className": "string",
            "filePath": "string",
            "functionName": "string"
          }
        ],
        "vulnerableFunctionsNotAvailable": [
          {}
        ],
        "vulnerableFunctionsNotInUse": [
          {}
        ]
      },
      "firstAffectedTimestamp": 1,
      "id": "string",
      "name": "string",
      "state": "AFFECTED",
      "vulnerableComponents": [
        {
          "displayName": "string",
          "fileName": "string",
          "id": "string",
          "loadOrigins": [
            "string"
          ],
          "shortName": "string"
        }
      ]
    }
  ]
}

Related topics