git.security.upload-sarif

Upload a SARIF 2.1.0 file of code scanning results for a commit

POST /git/api/repositories/{repoId}/code-scanning/sarifsIAM git:UploadCodeScanningResultsChanges state

Any SARIF-writing tool (Semgrep, CodeQL, Trivy, gosec). An analysis of the default branch updates the repository’s alerts and marks those it no longer reports fixed; an analysis of a pull request’s head shows on the pull request.

Request syntax

POST /git/api/repositories/{repoId}/code-scanning/sarifs
{
  "commitSha": "string",
  "ref": "string",
  "sarif": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Request body

  • commitShaRequired

    string

    The commit the analysis ran on

    Constraints: /^[0-9a-f]{40}$/

  • refRequired

    string

    The ref analysed: refs/heads/<branch>, or refs/pull/<n>/head for a pull request

    Constraints: 1-255 chars

  • sarifRequired

    string

    The SARIF 2.1.0 document, as JSON text (at most 12 MB)

    Constraints: 2-12582912 chars

Response

201 with `analyses`, one per tool run in the file: tool, analysisId, and the counts of `open` and `fixed` alerts.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • analysesAlways

    array of object

    One entry per tool run in the file
  • analyses[].​toolAlways

    string

    The tool of this run, e.g. Semgrep
  • analyses[].​analysisIdAlways

    string

    The analysis recorded for it
  • analyses[].​openAlways

    number

    Alerts it reports open
  • analyses[].​fixedAlways

    number

    Alerts it marked fixed by no longer reporting them

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:UploadCodeScanningResults on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git security upload-sarif repoId --commit-sha example --ref example --sarif example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_security_upload-sarif.