Skip to main content

Submit Remediation and Suppression Actions

POST 
/code/api/v1/errors/submitActions
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Invokes the suppress fix function in the correct service CI/CD remediations service based on the type of submit (PR or DEFAULT), array of violationsToSuppress, and array of violations to fix.

Request​

Bodyrequired

    cvesToSuppress object[]
  • Array [
    • CICDRunIddoublerequired
    bulkSuppressionboolean
    idstringrequired
    justification object
    commentstringrequired
    createdBystringrequired
    expirationTimedouble
    repositorystringrequired
    resourceIdstringrequired
    violationIdstringrequired
  • ]
    • metadata object
    ownerstringrequired
    prstring
    repoNamestringrequired
    runNumberdoublerequired
    sourceBranchNamestring
    sourceTypestring
    typeSubmitActionsType (string)required

    Possible values: [default, pr]

    violationsToFix object[]required
  • Array [
    • anyOf
    CICDRunIddoublerequired
    bulkSuppressionboolean
    commentIdsstring[]required
    creationDatestringrequired
    errorLinesdouble[]required
    frameworkTypestringrequired
    justification object
    commentstringrequired
    createdBystringrequired
    expirationTimedouble
    justificationIdstringnullablerequired
    metadataChecksMetadataPathstringrequired
    metadataLinesdouble[]required
    repositorystringrequired
    resourceIdstringrequired
    runtimeIdstringnullable
    runtimeSourceIdstringnullable
    s3FilePathstringrequired
    s3FixFilePathstringnullablerequired
    severitystringrequired
    statusstringrequired
    updatedDatestringrequired
    vcsCommentLinestringnullablerequired
    violationIdstringrequired
  • ]
    • violationsToSuppress object[]required
  • Array [
    • anyOf
    CICDRunIddoublerequired
    bulkSuppressionboolean
    commentIdsstring[]required
    creationDatestringrequired
    errorLinesdouble[]required
    frameworkTypestringrequired
    justification object
    commentstringrequired
    createdBystringrequired
    expirationTimedouble
    justificationIdstringnullablerequired
    metadataChecksMetadataPathstringrequired
    metadataLinesdouble[]required
    repositorystringrequired
    resourceIdstringrequired
    runtimeIdstringnullable
    runtimeSourceIdstringnullable
    s3FilePathstringrequired
    s3FixFilePathstringnullablerequired
    severitystringrequired
    statusstringrequired
    updatedDatestringrequired
    vcsCommentLinestringnullablerequired
    violationIdstringrequired
  • ]

Responses​

Schema
    data objectrequired
    messagestringrequired
    remediationsResponsestring[]

Authorization: authorization

name: authorizationtype: apiKeyin: headerx-amazon-apigateway-authorizer: {
  "authorizerResultTtlInSeconds": 0,
  "authorizerUri": "arn:aws:apigateway:{Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:{Region}:{AccountId}:function:bc-authorization-v2-authorizer-{UniqueTag}{Alias}/invocations",
  "identitySource": "method.request.header.authorization",
  "type": "request"
}x-amazon-apigateway-authtype: custom
curl -L -X POST 'https://pan.dev/code/api/v1/errors/submitActions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'authorization: <authorization>'
Request Collapse all
Auth
Body required
{
  "cvesToSuppress": [
    {
      "CICDRunId": 0,
      "bulkSuppression": true,
      "id": "string",
      "justification": {
        "comment": "string",
        "createdBy": "string",
        "expirationTime": 0
      },
      "repository": "string",
      "resourceId": "string",
      "violationId": "string"
    }
  ],
  "metadata": {
    "owner": "string",
    "pr": "string",
    "repoName": "string",
    "runNumber": 0,
    "sourceBranchName": "string"
  },
  "sourceType": "string",
  "type": "default",
  "violationsToFix": [
    {
      "CICDRunId": 0,
      "bulkSuppression": true,
      "commentIds": [
        "string"
      ],
      "creationDate": "string",
      "errorLines": [
        0
      ],
      "frameworkType": "string",
      "justification": {
        "comment": "string",
        "createdBy": "string",
        "expirationTime": 0
      },
      "justificationId": "string",
      "metadataChecksMetadataPath": "string",
      "metadataLines": [
        0
      ],
      "repository": "string",
      "resourceId": "string",
      "runtimeId": "string",
      "runtimeSourceId": "string",
      "s3FilePath": "string",
      "s3FixFilePath": "string",
      "severity": "string",
      "status": "string",
      "updatedDate": "string",
      "vcsCommentLine": "string",
      "violationId": "string"
    },
    {
      "errorLines": [
        0
      ],
      "fixPath": "string",
      "fixedCode": "string",
      "fixes": [
        {
          "code": "string",
          "fixedCode": "string",
          "id": "string",
          "inspectedKey": "string",
          "percent": 0,
          "recommenderType": "string",
          "times": 0
        }
      ],
      "frameworkType": "string",
      "fullId": "string",
      "inspectedKey": "string",
      "metadataChecksMetadataPath": "string",
      "metadataLines": [
        0
      ],
      "owner": "string",
      "repoName": "string",
      "resourceCode": "string",
      "resourceId": "string",
      "runtimeId": "string",
      "runtimeSourceId": "string",
      "s3FilePath": "string",
      "selectedFix": "string",
      "violationId": "string"
    },
    {
      "frameworkType": "string",
      "id": "string",
      "owner": "string",
      "packageName": "string",
      "packageVersion": "string",
      "repoName": "string",
      "resourceId": "string",
      "s3FilePath": "string",
      "violationId": "string"
    }
  ],
  "violationsToSuppress": [
    {
      "CICDRunId": 0,
      "bulkSuppression": true,
      "commentIds": [
        "string"
      ],
      "creationDate": "string",
      "errorLines": [
        0
      ],
      "frameworkType": "string",
      "justification": {
        "comment": "string",
        "createdBy": "string",
        "expirationTime": 0
      },
      "justificationId": "string",
      "metadataChecksMetadataPath": "string",
      "metadataLines": [
        0
      ],
      "repository": "string",
      "resourceId": "string",
      "runtimeId": "string",
      "runtimeSourceId": "string",
      "s3FilePath": "string",
      "s3FixFilePath": "string",
      "severity": "string",
      "status": "string",
      "updatedDate": "string",
      "vcsCommentLine": "string",
      "violationId": "string"
    },
    {
      "accountIds": [
        "string"
      ],
      "comment": "string",
      "cves": [
        "string"
      ],
      "expirationTime": 0,
      "suppressionType": "string",
      "violationId": "string"
    },
    {
      "comment": "string",
      "expirationTime": 0,
      "resources": [
        {
          "accountId": "string",
          "id": "string"
        }
      ],
      "suppressionType": "string",
      "violationId": "string"
    },
    {
      "comment": "string",
      "expirationTime": 0,
      "suppressionType": "string",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "violationId": "string"
    },
    {
      "accountIds": [
        "string"
      ],
      "comment": "string",
      "expirationTime": 0,
      "suppressionType": "string",
      "violationId": "string"
    },
    {
      "comment": "string",
      "expirationTime": 0,
      "suppressionType": "string",
      "violationId": "string"
    },
    {
      "accountIds": [
        "string"
      ],
      "comment": "string",
      "cves": [
        {
          "cve": "string",
          "id": "string",
          "uuid": "string"
        }
      ],
      "expirationTime": 0,
      "suppressionType": "string",
      "violationId": "string"
    },
    {
      "comment": "string",
      "expirationTime": 0,
      "licenseTypes": [
        "string"
      ],
      "suppressionType": "string",
      "violationId": "string"
    },
    {
      "comment": "string",
      "expirationTime": 0,
      "packages": [
        "string"
      ],
      "suppressByRoot": true,
      "suppressionType": "string",
      "violationId": "string"
    },
    {
      "bulkSuppression": true,
      "causePackageId": "string",
      "fileId": "string",
      "justification": {
        "comment": "string",
        "createdBy": "string",
        "expirationTime": 0
      },
      "license": "string",
      "repository": "string",
      "rootPackageId": "string",
      "run": 0,
      "violationId": "string"
    },
    {
      "comment": "string",
      "expirationTime": 0,
      "organizationId": "string",
      "suppressionType": "string",
      "violationId": "string"
    }
  ]
}