GET/v1/bom/token/{uuid}Deprecated

Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.

This endpoint is intended to be used in conjunction with uploading a supported BOM document. Upon upload, a token will be returned. The token can then be queried using this endpoint to determine if any tasks (such as vulnerability analysis) is being performed on the BOM:

A value of true indicates processing is occurring.
A value of false indicates that no processing is occurring for the specified token.

However, a value of false also does not confirm the token is valid, only that no processing is associated with the specified token.

Requires permission BOM_UPLOAD

Deprecated. Use /v1/event/token/{uuid} instead.

1 parameter

uuidstringrequired

The UUID of the token to query

2 status codes

200The processing status of the provided token

processingbooleanrequired

statusstringoptional

The processing status associated with the token. Null when no processing is associated with the token.

Allowed:PENDINGRUNNINGCOMPLETEDFAILED

401Unauthorized

Error handling

A 401 is returned: Unauthorized.

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

{
  "processing": true,
  "status": "PENDING"
}

Request

Response

Errors