git.security.set-code-scanning-alert

Dismiss a code scanning alert with a reason, or reopen it

PATCH /git/api/repositories/{repoId}/security/code-scanning-alerts/{alertId}IAM git:UpdateSecurityAlertChanges state

Request syntax

PATCH /git/api/repositories/{repoId}/security/code-scanning-alerts/{alertId}
{
  "state": "enum",
  "reason": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • alertIdRequired

    string

    Constraints: uuid

Request body

  • stateRequired

    enum

    `dismissed` closes the alert, `open` reopens it

    One of: open, dismissed

  • reasonOptional

    string

    Why it is dismissed

    Constraints: max 2000 chars

Response

200 with the alert in its new state, with dismissedReason.

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

Fields of data

  • idAlways

    string

    The alert
  • orgIdAlways

    string

    The organization
  • repoIdAlways

    string

    The repository
  • toolAlways

    string

    The tool that reported it, e.g. Semgrep
  • fingerprintAlways

    string

    Identifies the same finding across uploads
  • stateAlways

    one of open, fixed, dismissed

    fixed once an analysis of the default branch no longer reports it
  • ruleIdAlways

    string

    The tool's rule id
  • ruleDescriptionAlways

    string, may be null

    The rule's description; null when the tool gives none
  • severityAlways

    one of critical, high, medium, low, note

    The severity
  • messageAlways

    string

    What the tool says about this finding
  • pathAlways

    string

    The file, from the repository root
  • startLineAlways

    number, may be null

    First line of the finding; null when not given
  • endLineAlways

    number, may be null

    Last line of the finding; null when not given
  • helpUriAlways

    string, may be null

    A link to the rule's documentation; null when none
  • firstSeenCommitOidAlways

    string

    The commit it was first reported on
  • lastSeenCommitOidAlways

    string

    The commit it was last reported on
  • lastSeenRefAlways

    string

    The ref of the analysis that last saw it: the default branch or a pull request head
  • dismissedReasonAlways

    string, may be null

    Why it was dismissed; null unless dismissed
  • dismissedByIamUserIdAlways

    string, may be null

    Who dismissed it; null unless dismissed
  • fixedAtAlways

    string, may be null

    When it was found fixed (ISO 8601); null until then
  • createdAtAlways

    string

    When it was first reported (ISO 8601)
  • updatedAtAlways

    string

    When the alert last changed (ISO 8601)

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:UpdateSecurityAlert 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 set-code-scanning-alert repoId alertId --state open

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_security_set-code-scanning-alert.