Remediations

APIs for managing Remediation

Get Fix Suggestion

get

Retrieves a comprehensive fix suggestion for a specified application security issue. Use optional query parameters to include data such as the original code block, remediation instructions, or the suggested code fix.

Required license:

Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Path parameters

issueIdstringRequired

The unique identifier for the specific application security issue.

Example: 1234567

Query parameters

showCodeBlockbooleanOptional

Specifies whether to include the original code block in the response.

Default: true

showRemediationInstructionbooleanOptional

Specifies whether to include manual remediation instructions in the response.

Default: false

showSuggestedCodeBlockbooleanOptional

Specifies whether to include the automated code fix in the response.

Default: true

Responses

200

Fix Suggestion Response

application/json

issueIdstringRequired

Unique identifier for the issue.

issueNamestringRequired

Name of the security issue.

existingCodeBlockstringOptional

Original vulnerable code.

remediationInstructionstringOptional

Manual remediation instructions.

suggestedCodeBlockstringOptional

Automated fix suggestions.

get/public_api/appsec/v1/issues/fix/{issueId}/fix_suggestion

GET /public_api/appsec/v1/issues/fix/{issueId}/fix_suggestion HTTP/1.1
Host: api-yourfqdn
Accept: */*

200

Fix Suggestion Response

{
  "issueId": "text",
  "issueName": "text",
  "existingCodeBlock": "text",
  "remediationInstruction": "text",
  "suggestedCodeBlock": "text"
}

Trigger Fix Pull Request

post

Create automated pull requests to fix multiple security issues in a single bulk operation.

Required license:

Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Body

fixBranchNamestringOptional

The branch name for the fix pull request. If not specified, a custom branch will be used.

titlestringOptional

The title for the fix pull request. If not specified, a default message will be used.

issueIdsstring[]Required

A list of unique identifiers for the issues to be fixed. Maximum 10 IDs per request.

Example: ["1234567","9876543"]

Responses

200

Ok

application/json

messagestringRequired

Error message if the process fails.

statusstringOptional

Overall process status.

remediationIdstringOptional

Unique identifier to track the remediation process

errorstringOptional

Error details if the process fails.

post/public_api/appsec/v1/issues/fix/trigger_fix_pull_request

POST /public_api/appsec/v1/issues/fix/trigger_fix_pull_request HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "fixBranchName": "text",
  "title": "text",
  "issueIds": [
    "1234567",
    "9876543"
  ]
}

200

Ok

{
  "message": "text",
  "triggeredPrs": [
    {
      "issueId": "text",
      "status": "triggered"
    }
  ],
  "status": "text",
  "remediationId": "text",
  "error": "text"
}

Get Fix Status

get

Retrieves the fix status of remediation processes using the remediation ID.

Required license:

Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Path parameters

remediationIdstringRequired

Remediation Id

Responses

200

Ok

application/json

isProcessDonebooleanRequired

Indicates whether all remediation processes are complete.

get/public_api/appsec/v1/issues/fix/{remediationId}

GET /public_api/appsec/v1/issues/fix/{remediationId} HTTP/1.1
Host: api-yourfqdn
Accept: */*

200

Ok

{
  "isProcessDone": true,
  "results": [
    {
      "prUrl": "text",
      "errorMessage": "text",
      "remediationRepositoryId": "text",
      "failureIssueIds": [
        "text"
      ],
      "successfulIssueIds": [
        "text"
      ]
    }
  ]
}