Returns a list of all projects | Dependency-Track unofficial

10 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

namestringoptional

The optional name of the project to query on

excludeInactivebooleanoptional

Optionally excludes inactive projects from being returned

onlyRootbooleanoptional

Optionally excludes children projects from being returned

notAssignedToTeamWithUuidstringoptional

The UUID of the team which projects shall be excluded

2 status codes

200A list of all projects

activebooleanoptional

authorsarray<object>optional

classifierstringoptional

Allowed:APPLICATIONFRAMEWORKLIBRARYCONTAINEROPERATING_SYSTEMDEVICEFIRMWAREFILEPLATFORMDEVICE_DRIVERMACHINE_LEARNING_MODELDATA

collectionLogicstringoptional

Allowed:AGGREGATE_DIRECT_CHILDRENAGGREGATE_DIRECT_CHILDREN_WITH_TAGAGGREGATE_LATEST_VERSION_CHILDREN

collectionTagobjectoptional

cpestringoptional

descriptionstringoptional

directDependenciesstringoptional

externalReferencesarray<object>optional

groupstringoptional

hasChildrenbooleanrequired

Whether the project has child projects

inactiveSinceintegeroptional

UNIX epoch timestamp in milliseconds

isLatestbooleanoptional

lastBomImportintegerrequired

UNIX epoch timestamp in milliseconds

lastBomImportFormatstringoptional

lastInheritedRiskScorenumberoptional

lastVulnerabilityAnalysisintegeroptional

UNIX epoch timestamp in milliseconds

manufacturerobjectoptional

metadataobjectoptional

metricsobjectoptional

namestringrequired

parentobjectoptional

publisherstringoptional

purlstringoptional

supplierobjectoptional

swidTagIdstringoptional

tagsarray<object>optional

uuidstringrequired

versionstringoptional

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

[
  {
    "active": true,
    "authors": [
      {
        "email": "user@example.com",
        "name": "Example Name",
        "phone": "+44 7700 900123"
      }
    ],
    "classifier": "APPLICATION",
    "collectionLogic": "AGGREGATE_DIRECT_CHILDREN",
    "collectionTag": {
      "name": "Example Name"
    },
    "cpe": "example_value",
    "description": "Example description",
    "directDependencies": "example_value",
    "externalReferences": [
      {
        "comment": "example_value",
        "type": "vcs",
        "url": "https://example.com"
      }
    ],
    "group": "example_value",
    "hasChildren": true,
    "inactiveSince": 1,
    "isLatest": true,
    "lastBomImport": 1,
    "lastBomImportFormat": "example_value",
    "lastInheritedRiskScore": 1,
    "lastVulnerabilityAnalysis": 1,
    "manufacturer": {
      "contacts": [
        {
          "email": "user@example.com",
          "name": "Example Name",
          "phone": "+44 7700 900123"
        }
      ],
      "name": "Example Name",
      "urls": [
        "https://example.com"
      ]
    },
    "metadata": {
      "authors": [
        {
          "email": "user@example.com",
          "name": "Example Name",
          "phone": "+44 7700 900123"
        }
      ],
      "supplier": {
        "contacts": [
          {
            "email": "user@example.com",
            "name": "Example Name",
            "phone": "+44 7700 900123"
          }
        ],
        "name": "Example Name",
        "urls": [
          "https://example.com"
        ]
      },
      "tools": {
        "components": [
          {
            "author": "example_value",
            "authors": [
              null
            ],
            "blake2b_256": "example_value",
            "blake2b_384": "example_value",
            "blake2b_512": "example_value",
            "blake3": "example_value",
            "children": [
              null
            ],
            "classifier": "APPLICATION",
            "copyright": "example_value",
            "cpe": "example_value",
            "dependencyGraph": [
              null
            ],
            "description": "Example description",
            "directDependencies": "example_value",
            "expandDependencyGraph": true,
            "extension": "example_value",
            "externalReferences": [
              null
            ],
            "filename": "Example Name",
            "group": "example_value",
            "isInternal": true,
            "lastInheritedRiskScore": 1,
            "license": "example_value",
            "licenseExpression": "example_value",
            "licenseUrl": "https://example.com",
            "md5": "example_value",
            "metrics": {
              "critical": null,
              "findingsAudited": null,
              "findingsTotal": null,
              "findingsUnaudited": null,
              "firstOccurrence": null,
              "high": null,
              "inheritedRiskScore": null,
              "kev": null,
              "lastOccurrence": null,
              "low": null,
              "medium": null,
              "policyViolationsAudited": null,
              "policyViolationsFail": null,
              "policyViolationsInfo": null,
              "policyViolationsLicenseAudited": null,
              "policyViolationsLicenseTotal": null,
              "policyViolationsLicenseUnaudited": null,
              "policyViolationsOperationalAudited": null,
              "policyViolationsOperationalTotal": null,
              "policyViolationsOperationalUnaudited": null,
              "policyViolationsSecurityAudited": null,
              "policyViolationsSecurityTotal": null,
              "policyViolationsSecurityUnaudited": null,
              "policyViolationsTotal": null,
              "policyViolationsUnaudited": null,
              "policyViolationsWarn": null,
              "suppressed": null,
              "unassigned": null,
              "vulnerabilities": null
            },
            "name": "Example Name",
            "notes": "example_value",
            "occurrenceCount": 42,
            "parent": {
              "author": null,
              "authors": null,
              "blake2b_256": null,
              "blake2b_384": null,
              "blake2b_512": null,
              "blake3": null,
              "children": null,
              "classifier": null,
              "copyright": null,
              "cpe": null,
              "dependencyGraph": null,
              "description": null,
              "directDependencies": null,
              "expandDependencyGraph": null,
              "extension": null,
              "externalReferences": null,
              "filename": null,
              "group": null,
              "isInternal": null,
              "lastInheritedRiskScore": null,
              "license": null,
              "licenseExpression": null,
              "licenseUrl": null,
              "md5": null,
              "metrics": null,
              "name": null,
              "notes": null,
              "occurrenceCount": null,
              "parent": null,
              "project": null,
              "properties": null,
              "publisher": null,
              "purl": null,
              "purlCoordinates": null,
              "repositoryMeta": null,
              "resolvedLicense": null,
              "scope": null,
              "sha1": null,
              "sha256": null,
              "sha384": null,
              "sha3_256": null,
              "sha3_384": null,
              "sha3_512": null,
              "sha512": null,
              "streebog_256": null,
              "streebog_512": null,
              "supplier": null,
              "swidTagId": null,
              "uuid": null,
              "version": null,
              "vulnerabilities": null
            },
            "project": {
              "accessTeams": null,
              "active": null,
              "author": null,
              "authors": null,
              "bomRef": null,
              "children": null,
              "classifier": null,
              "collectionLogic": null,
              "collectionTag": null,
              "cpe": null,
              "description": null,
              "directDependencies": null,
              "externalReferences": null,
              "group": null,
              "inactiveSince": null,
              "isLatest": null,
              "lastBomImport": null,
              "lastBomImportFormat": null,
              "lastInheritedRiskScore": null,
              "lastVulnerabilityAnalysis": null,
              "manufacturer": null,
              "metadata": null,
              "metrics": null,
              "name": null,
              "parent": null,
              "publisher": null,
              "purl": null,
              "supplier": null,
              "swidTagId": null,
              "tags": null,
              "uuid": null,
              "version": null,
              "versions": null
            },
            "properties": [
              null
            ],
            "publisher": "example_value",
            "purl": "https://example.com",
            "purlCoordinates": "https://example.com",
            "repositoryMeta": {
              "lastCheck": null,
              "latestVersion": null,
              "latestVersionPublishedAt": null,
              "name": null,
              "namespace": null,
              "repositoryType": null
            },
            "resolvedLicense": {
              "isCustomLicense": null,
              "isDeprecatedLicenseId": null,
              "isFsfLibre": null,
              "isOsiApproved": null,
              "licenseComments": null,
              "licenseGroups": null,
              "licenseId": null,
              "licenseText": null,
              "name": null,
              "seeAlso": null,
              "standardLicenseHeader": null,
              "standardLicenseTemplate": null,
              "uuid": null
            },
            "scope": "REQUIRED",
            "sha1": "example_value",
            "sha256": "example_value",
            "sha384": "example_value",
            "sha3_256": "example_value",
            "sha3_384": "example_value",
            "sha3_512": "example_value",
            "sha512": "example_value",
            "streebog_256": "example_value",
            "streebog_512": "example_value",
            "supplier": {
              "contacts": null,
              "name": null,
              "urls": null
            },
            "swidTagId": "550e8400-e29b-41d4-a716-446655440000",
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "version": "example_value",
            "vulnerabilities": [
              null
            ]
          }
        ],
        "services": [
          {
            "authenticated": true,
            "bomRef": "example_value",
            "children": [
              null
            ],
            "crossesTrustBoundary": true,
            "data": [
              null
            ],
            "description": "Example description",
            "endpoints": [
              null
            ],
            "externalReferences": [
              null
            ],
            "group": "example_value",
            "lastInheritedRiskScore": 1,
            "name": "Example Name",
            "notes": "example_value",
            "parent": {
              "authenticated": null,
              "bomRef": null,
              "children": null,
              "crossesTrustBoundary": null,
              "data": null,
              "description": null,
              "endpoints": null,
              "externalReferences": null,
              "group": null,
              "lastInheritedRiskScore": null,
              "name": null,
              "notes": null,
              "parent": null,
              "project": null,
              "provider": null,
              "uuid": null,
              "version": null,
              "vulnerabilities": null
            },
            "project": {
              "accessTeams": null,
              "active": null,
              "author": null,
              "authors": null,
              "bomRef": null,
              "children": null,
              "classifier": null,
              "collectionLogic": null,
              "collectionTag": null,
              "cpe": null,
              "description": null,
              "directDependencies": null,
              "externalReferences": null,
              "group": null,
              "inactiveSince": null,
              "isLatest": null,
              "lastBomImport": null,
              "lastBomImportFormat": null,
              "lastInheritedRiskScore": null,
              "lastVulnerabilityAnalysis": null,
              "manufacturer": null,
              "metadata": null,
              "metrics": null,
              "name": null,
              "parent": null,
              "publisher": null,
              "purl": null,
              "supplier": null,
              "swidTagId": null,
              "tags": null,
              "uuid": null,
              "version": null,
              "versions": null
            },
            "provider": {
              "contacts": null,
              "name": null,
              "urls": null
            },
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "version": "example_value",
            "vulnerabilities": [
              null
            ]
          }
        ]
      }
    },
    "metrics": {
      "components": 1,
      "critical": 1,
      "findingsAudited": 1,
      "findingsTotal": 42,
      "findingsUnaudited": 1,
      "firstOccurrence": 1,
      "high": 1,
      "inheritedRiskScore": 1,
      "kev": 1,
      "lastOccurrence": 1,
      "low": 1,
      "medium": 1,
      "policyViolationsAudited": 1,
      "policyViolationsFail": 1,
      "policyViolationsInfo": 1,
      "policyViolationsLicenseAudited": 1,
      "policyViolationsLicenseTotal": 42,
      "policyViolationsLicenseUnaudited": 1,
      "policyViolationsOperationalAudited": 1,
      "policyViolationsOperationalTotal": 42,
      "policyViolationsOperationalUnaudited": 1,
      "policyViolationsSecurityAudited": 1,
      "policyViolationsSecurityTotal": 42,
      "policyViolationsSecurityUnaudited": 1,
      "policyViolationsTotal": 42,
      "policyViolationsUnaudited": 1,
      "policyViolationsWarn": 1,
      "suppressed": 1,
      "unassigned": 1,
      "vulnerabilities": 1,
      "vulnerableComponents": 1
    },
    "name": "Example Name",
    "parent": {
      "name": "Example Name",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "version": "example_value"
    },
    "publisher": "example_value",
    "purl": "https://example.com",
    "supplier": {
      "contacts": [
        {
          "email": "user@example.com",
          "name": "Example Name",
          "phone": "+44 7700 900123"
        }
      ],
      "name": "Example Name",
      "urls": [
        "https://example.com"
      ]
    },
    "swidTagId": "550e8400-e29b-41d4-a716-446655440000",
    "tags": [
      {
        "name": "Example Name"
      }
    ],
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "version": "example_value"
  }
]

Request

Response

Errors