Sign in

v1

latestOpenAPI 3.0.12026-08-06151265417.9 KB
Findings - Project

Get project due diligence information (Dependencies - SCA)

Returns a due diligence report listing the source and license information for all libraries in a project

get/api/v3.0/projects/{projectUuid}/dependencies/libraries/licenses

Path parameters

projectUuidstring required

UUID of the project

Query parameters

limitstring

Specifies the maximum number of items to be returned in the response.

cursorstring

Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.

Response

OK

additionalDataobject
  • totalItems: The total count of data points returned in an API response.
supportTokenstring

Example response

{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    {
      "component": {
        "uuid": "123e4567-e89b-12d3-a456-426655440000",
        "name": "dbus-1.10.24-13.el7_6.x86_64.rpm",
        "description": "Component description",
        "componentType": "Library",
        "libraryType": "REDHAT_PACKAGE_MODULE",
        "language": "REDHAT_PACKAGE_MODULE",
        "references": {
          "url": "https://www.gnupg.org/related_software/pinentry/98",
          "homePage": "https://www.gnupg.org/related_software/pinentry/89",
          "downloadLink": "https://www.gnupg.org/related_software/pinentry/09",
          "issueUrl": "https://www.gnupg.org/related_software/pinentry/87",
          "pomUrl": "https://www.gnupg.org/related_software/pinentry/76",
          "scmUrl": "https://www.gnupg.org/related_software/pinentry/65",
          "genericPackageIndex": "5",
          "tags": "Important",
          "copyright": "Copyright 2002-2015 g10 Code GmbH"
        },
        "groupId": "org.springframework.boot",
        "artifactId": "spring-boot",
        "version": "3.0.5",
        "path": "pom.xml",
        "dependencyType": "Direct / Transitive"
      },
      "license": {
        "uuid": "123e4567-e89b-12d3-a456-426655440000",
        "type": "ARTIFACT_DESCRIPTOR",
        "liabilityReference": "https://repo.maven.apache.org/maven2/org/jruby/ext/posix/jna-posix/1.0.3/jna-posix-1.0.3.pom",
        "assignedBy": {
          "uuid": "123e4567-e89b-12d3-a456-426655440000",
          "name": "Jon Smith",
          "email": "jon.smith@mail.com",
          "userType": "REGULAR"
        },
        "information": "distribution=repo&remoteUrl=https://repo.maven.apache.org/maven2/org/jruby/ext/posix/jna-posix/1.0.3/jna-posix-1.0.3.pom"
      },
      "riskScore": {
        "explanation": "http://en.wikipedia.org/wiki/Academic_Free_License",
        "indicatingText": "1) Grant of Copyright License...",
        "riskScore": 39
      },
      "copyrights": [
        "Copyright 2010 Cloud Conscious, LLC"
      ],
      "extraData": {
        "homepage": "https://api.github.com/repos/SR-dude/AvP-Wine/zipball/original",
        "authors": [
          {
            "author": "The Apache Software Foundation",
            "authorUrl": "http://www.apache.org/"
          }
        ]
      },
      "project": {
        "uuid": "123e4567-e89b-12d3-a456-426655440000",
        "name": "My Project",
        "path": "My Application",
        "applicationName": "My Application",
        "applicationUuid": "123e4567-e89b-12d3-a456-426655440000"
      }
    }
  ]
}