Returns dependency metadata for a specific component in CycloneDX

3 parameters

uuidstringrequired

The UUID of the component to export

formatstringoptional

The format to output (defaults to JSON)

versionstringoptional

The CycloneDX Spec variant exported (defaults to: '1.5')

4 status codes

200Dependency metadata for a specific component in CycloneDX format

401Unauthorized

403Access to the requested project is forbidden

detailstringrequired

Human-readable explanation specific to this occurrence of the problem

instancestringoptional

Reference URI that identifies the specific occurrence of the problem

statusintegerrequired

HTTP status code generated by the origin server for this occurrence of the problem

titlestringrequired

Short, human-readable summary of the problem type

typestringoptional

A URI reference that identifies the problem type

404The component could not be found

Error handling

A 401 is returned: Unauthorized. A 403 is returned: Access to the requested project is forbidden. A 404 is returned: The component could not be found.

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.component.get({
  uuid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  format: "example",
  version: "example",
});

"example_value"

Request

Response

Errors