Dependency-Track unofficial
GET/v1/license

List licenses with complete metadata

Lists licenses with their complete metadata, including license text, identifiers, approval flags, and associated license groups. Use pageNumber and pageSize or offset and limit to control which licenses are returned.

6 parameters
pageNumberstringoptional
Page number to return, used with `pageSize`. Defaults to 1 when omitted.
Default:1
pageSizestringoptional
Number of licenses per page, used with `pageNumber`. Defaults to 100 when omitted.
Default:100
offsetstringoptional
Index of the first license to return, used with `limit`.
limitstringoptional
Maximum number of licenses to return, used with `offset`.
sortNamestringoptional
Name of the license field to sort by.
sortOrderstringoptional
Sort direction for `sortName`; the documented enum value is `asc, desc`.
Allowed:asc, desc

2 status codes
200Returns an array of license objects containing license identifiers and names, approval and deprecation flags, license text and templates, related URLs, and license group metadata.
isCustomLicensebooleanrequired
Whether the license is a custom license created by a user
isDeprecatedLicenseIdbooleanrequired
Whether the licenseId has been deprecated by SPDX
isFsfLibrebooleanrequired
Whether the license is FSF libre
isOsiApprovedbooleanrequired
Whether the license is approved by the OSI
licenseCommentsstringoptional
Comments about the license
licenseGroupsarray<object>required
License groups the license belongs to
licenseIdstringrequired
Identifier of the license
licenseTextstringoptional
Full license text
namestringrequired
Display name of the license
seeAlsoarray<string>optional
Additional URLs with information about the license
standardLicenseHeaderstringoptional
Standard license header typically added to the top of source code
standardLicenseTemplatestringoptional
Standard license template used to derive the license text
uuidstringrequired
UUID of the license
401Returned when the request is unauthorized.

Error handling

A 401 is returned when the request is unauthorized. When supplied, sortOrder must match the documented enum value asc, desc.