Returns a list of all tags | Dependency-Track unofficial

6 parameters

pageNumberstringoptional

The page to return. To be used in conjunction with <code>pageSize</code>.

Default:1

pageSizestringoptional

Number of elements to return per page. To be used in conjunction with <code>pageNumber</code>.

Default:100

offsetstringoptional

Offset to start returning elements from. To be used in conjunction with <code>limit</code>.

limitstringoptional

Number of elements to return per page. To be used in conjunction with <code>offset</code>.

sortNamestringoptional

Name of the resource field to sort on.

sortOrderstringoptional

Ordering of items when sorting with <code>sortName</code>.

Allowed:asc, desc

1 status code

200A list of all tags

collectionProjectCountintegerrequired

Number of collection projects assigned to this tag

namestringrequired

Name of the tag

notificationRuleCountintegerrequired

Number of notification rules assigned to this tag

policyCountintegerrequired

Number of policies assigned to this tag

projectCountintegerrequired

Number of projects assigned to this tag

vulnerabilityCountintegerrequired

Number of vulnerabilities assigned to this tag

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.tag.list({
  pageNumber: 1,
  pageSize: 20,
  offset: 0,
  limit: 20,
  sortName: "Untitled",
});

[
  {
    "collectionProjectCount": 42,
    "name": "Example Name",
    "notificationRuleCount": 42,
    "policyCount": 42,
    "projectCount": 42,
    "vulnerabilityCount": 42
  }
]