Vulnerabilities API - POST remediation item tracking links

Adds, edits, or deletes the tracking links of remediation tracking process groups of a third-party vulnerability (or, in the case of Kubernetes vulnerabilities, of remediation tracking Kubernetes nodes).

The request produces an application/json payload.

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

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

Contains the external tracking link associations to be set or deleted on the remediation items of the security problem.

  • Links to be set should be submitted in the updates object.
  • Links to be deleted should be submitted in the deletes array.

The request must contain at least one entry to set or delete to be valid.

Conflicting changes for the same remediation item (ID appears both in the deletes and updates field) cannot be submitted.

Note that all tracking link updates for the security problem should be submitted in one request.

body
optional

Request body objects

The RemediationItemsBulkUpdateDeleteDto object

Contains the external tracking link associations to be applied to the remediation items of the security problem.

Element
Type
Description
Required
deletes
string[]

Tracking links to remove from the security problem.

List of remediation item IDs of the security problem for which to remove the tracking links.

optional
updates
object

Tracking links to set for the security problem.

Map of remediation item ID to tracking link objects.

Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.

optional

The TrackingLinkUpdate object

External tracking link URL association to be set for the remediable entity of the security problem.

Element
Type
Description
Required
displayName
string

The desired tracking link display name (title) set for the remediation item, e.g. 'ISSUE-123'.

required
url
string

The desired tracking link url set for the remediation item, e.g. https://example.com/ISSUE-123

Note that only valid URLs with 'http' or 'https' protocols are supported.

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.

{
  "deletes": [
    "string"
  ],
  "updates": {}
}

Response

Response codes

Code
Type
Description
204
-

Success. The requested tracking links have been updated.

4XX

Client side error.

5XX

Server side error.

Examples

Setup: There's an automation in place that creates a ticket for each remediable entity automatically.

Goal: Make the endpoint link the ticket with the remediation item. The following tracking links will be set:

  • https://example.com/TICKET-46C0E12D9B0EF2D9 for "PROCESS_GROUP-46C0E12D9B0EF2D9"

  • https://example.com/TICKET-549E6AD75BD598EC for "PROCESS_GROUP-549E6AD75BD598EC"

Curl

curl -X 'POST' 'https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/2919200225913269102/remediationItems/trackingLinks' \
-H 'accept: */*' \
-H 'Authorization: Api-Token [your_token]' \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{
"updates": {
"PROCESS_GROUP-46C0E12D9B0EF2D9": {
"displayName": "TICKET-46C0E12D9B0EF2D9",
"url": "https://example.com/TICKET-46C0E12D9B0EF2D9"
},
"PROCESS_GROUP-549E6AD75BD598EC": {
"displayName": "TICKET-549E6AD75BD598EC",
"url": "https://example.com/TICKET-549E6AD75BD598EC"
}
}
}'

Request URL

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

Request body

{
  "updates": {
"PROCESS_GROUP-46C0E12D9B0EF2D9": {
"displayName": "TICKET-46C0E12D9B0EF2D9",
"url": "https://example.com/TICKET-46C0E12D9B0EF2D9"
},
"PROCESS_GROUP-549E6AD75BD598EC": {
"displayName": "TICKET-549E6AD75BD598EC",
"url": "https://example.com/TICKET-549E6AD75BD598EC"
}
}
}

Response code

200

Remove tracking links from "PROCESS_GROUP-46C0E12D9B0EF2D9" and "PROCESS_GROUP-549E6AD75BD598EC".

Curl

curl -X 'POST' 'https://mySampleEnv.live.dynatrace.com/api/v2/securityProblems/2919200225913269102/remediationItems/trackingLinks' \
-H 'accept: */*' \
-H 'Authorization: Api-Token [your_token]' \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{
  "deletes": ["PROCESS_GROUP-46C0E12D9B0EF2D9", "PROCESS_GROUP-549E6AD75BD598EC"]
}
}'

Request URL

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

Request body

{
  "deletes": ["PROCESS_GROUP-46C0E12D9B0EF2D9", "PROCESS_GROUP-549E6AD75BD598EC"]
}

Response code

200

Related topics