Applications

Get List of Scan SDKs

Use this API to retrieve a paginated list of SDKs detected during a specific application scan. The response includes each SDK's ID, name, vendor, and default category. Results can be filtered and sorted using optional query parameters for name, vendor, default category, and the package ID.

🗒 Things to Know

  • SDKs returned by this endpoint are scan-detected SDKs and are different from Tracking Technology SDKs, which have custom descriptions and categories.
get/api/cmp/v1/applications/{id}/scans/{scanId}/sdks

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/cmp/v1/applications/{id}/scans/{scanId}/sdks
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: COOKIE_READ

Path parameters

idstring uuid required

Unique identifier of the application.

scanIdstring uuid required

Unique identifier the scan.

Query parameters

sortBy'pkgId' | 'name' | 'category' | 'vendor'

Field to sort by

direction'asc' | 'desc'

Sort direction

pageinteger
Example:1

Page number

pageSizeinteger
Example:10

Page size

nameSearchstring

Filter SDKs whose name contains this value (case-insensitive)

vendorSearchstring

Filter SDKs whose vendor contains this value (case-insensitive)

defaultCategorySearchstring

Filter SDKs whose default category contains this value (case-insensitive)

Response

OK

totalPagesinteger
totalElementsinteger
sizeinteger
numberinteger
firstboolean
lastboolean
numberOfElementsinteger
emptyboolean

Example response

{
  "content": [
    {
      "packageId": "org.apache.commons.math3",
      "name": "Apache Commons Math Library",
      "vendor": "Apache Software Foundation",
      "category": "Strictly Necessary",
      "description": "The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.