git.security.get-dependency-alert

One dependency alert: the advisory in full, CVSS, links, why the package is installed, and every place it is

GET /git/api/repositories/{repoId}/security/dependency-alerts/{alertId}IAM git:ListSecurityAlertsRead

Request syntax

GET /git/api/repositories/{repoId}/security/dependency-alerts/{alertId}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • alertIdRequired

    string

    Constraints: uuid

Response

200 with `alert` (the advisory: description, cvssScore, cvssVector, references, aliases, relationship, chain, among others) and `places`, every lockfile entry of the same package and advisory.

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

Fields of data

  • alertAlways

    object

    The alert, with the advisory in full
  • alert.​idAlways

    string

    The alert
  • alert.​orgIdAlways

    string

    The organization
  • alert.​repoIdAlways

    string

    The repository
  • alert.​stateAlways

    one of open, fixed, dismissed

    fixed once a scan no longer finds the vulnerable version
  • alert.​manifestPathAlways

    string

    The lockfile the package is installed by
  • alert.​ecosystemAlways

    string

    The package ecosystem, e.g. npm
  • alert.​packageNameAlways

    string

    The vulnerable package
  • alert.​installedVersionAlways

    string

    The version the lockfile installs
  • alert.​fixedVersionAlways

    string, may be null

    The first version with the fix; null if none yet
  • alert.​vulnerabilityIdAlways

    string

    The advisory id, e.g. GHSA-… or CVE-…
  • alert.​severityAlways

    one of critical, high, medium, low, unknown

    The severity
  • alert.​titleAlways

    string

    The advisory's title
  • alert.​urlAlways

    string, may be null

    A link to the advisory; null when it has none
  • alert.​cvssScoreAlways

    number, may be null

    CVSS base score, 0 to 10; null when not published
  • alert.​cvssVectorAlways

    string, may be null

    CVSS vector string; null when not published
  • alert.​referencesAlways

    array of string

    Links the advisory cites
  • alert.​aliasesAlways

    array of string

    Other ids of the same advisory
  • alert.​publishedAtAlways

    string, may be null

    When the advisory was published (ISO 8601); null when unknown
  • alert.​relationshipAlways

    one of direct, indirect, may be null

    direct: named in the manifest; indirect: pulled in by another package; null when unknown
  • alert.​chainAlways

    array of string

    From a direct dependency down to this package, name@version each
  • alert.​devAlways

    boolean, may be null

    Only a development dependency; null when unknown
  • alert.​lastSeenCommitOidAlways

    string

    The default-branch commit of the scan that last saw it
  • alert.​dismissedReasonAlways

    string, may be null

    Why it was dismissed; null unless dismissed
  • alert.​dismissedCommentAlways

    string, may be null

    Own words beside the reason; null unless given
  • alert.​dismissedAtAlways

    string, may be null

    When it was dismissed (ISO 8601); null unless dismissed
  • alert.​dismissedByIamUserIdAlways

    string, may be null

    Who dismissed it; null unless dismissed
  • alert.​fixedAtAlways

    string, may be null

    When a scan found it fixed (ISO 8601); null until then
  • alert.​createdAtAlways

    string

    When it was first found (ISO 8601)
  • alert.​updatedAtAlways

    string

    When the alert last changed (ISO 8601)
  • alert.​descriptionAlways

    string, may be null

    The advisory as published (Markdown); null for alerts found before it was kept
  • placesAlways

    array of object

    Every lockfile entry of the same package and advisory, this one included, by lockfile
  • places[].​idAlways

    string

    The alert
  • places[].​orgIdAlways

    string

    The organization
  • places[].​repoIdAlways

    string

    The repository
  • places[].​stateAlways

    one of open, fixed, dismissed

    fixed once a scan no longer finds the vulnerable version
  • places[].​manifestPathAlways

    string

    The lockfile the package is installed by
  • places[].​ecosystemAlways

    string

    The package ecosystem, e.g. npm
  • places[].​packageNameAlways

    string

    The vulnerable package
  • places[].​installedVersionAlways

    string

    The version the lockfile installs
  • places[].​fixedVersionAlways

    string, may be null

    The first version with the fix; null if none yet
  • places[].​vulnerabilityIdAlways

    string

    The advisory id, e.g. GHSA-… or CVE-…
  • places[].​severityAlways

    one of critical, high, medium, low, unknown

    The severity
  • places[].​titleAlways

    string

    The advisory's title
  • places[].​urlAlways

    string, may be null

    A link to the advisory; null when it has none
  • places[].​cvssScoreAlways

    number, may be null

    CVSS base score, 0 to 10; null when not published
  • places[].​cvssVectorAlways

    string, may be null

    CVSS vector string; null when not published
  • places[].​referencesAlways

    array of string

    Links the advisory cites
  • places[].​aliasesAlways

    array of string

    Other ids of the same advisory
  • places[].​publishedAtAlways

    string, may be null

    When the advisory was published (ISO 8601); null when unknown
  • places[].​relationshipAlways

    one of direct, indirect, may be null

    direct: named in the manifest; indirect: pulled in by another package; null when unknown
  • places[].​chainAlways

    array of string

    From a direct dependency down to this package, name@version each
  • places[].​devAlways

    boolean, may be null

    Only a development dependency; null when unknown
  • places[].​lastSeenCommitOidAlways

    string

    The default-branch commit of the scan that last saw it
  • places[].​dismissedReasonAlways

    string, may be null

    Why it was dismissed; null unless dismissed
  • places[].​dismissedCommentAlways

    string, may be null

    Own words beside the reason; null unless given
  • places[].​dismissedAtAlways

    string, may be null

    When it was dismissed (ISO 8601); null unless dismissed
  • places[].​dismissedByIamUserIdAlways

    string, may be null

    Who dismissed it; null unless dismissed
  • places[].​fixedAtAlways

    string, may be null

    When a scan found it fixed (ISO 8601); null until then
  • places[].​createdAtAlways

    string

    When it was first found (ISO 8601)
  • places[].​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:ListSecurityAlerts 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 get-dependency-alert repoId alertId

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