Get a project vulnerabilities badge | Dependency-Track unofficial

2 parameters

namestringrequired

The name of the project to retrieve the vulnerability badge for.

versionstringrequired

The version of the project to retrieve the vulnerability badge for.

3 status codes

200Returns an SVG image displaying the project's current vulnerability metrics.

403Returned when badges are disabled.

404Returned when the project could not be found.

Error handling

A 403 is returned when badges are disabled. A 404 is returned when the project cannot be found. The name and version path parameters must identify an existing project.

import { Client } from "dependency-track-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:8081/api",
  auth: { apiKey: process.env.API_KEY },
});

const result = await client.project.get({
  name: "Untitled",
  version: "example",
});

"example_value"

Request

Response

Errors