getSbom

Retrieves SBOM libraries with filtering and pagination support.

Examples

GraphQL

query GetSbom($input: GetSbomInput) {
  getSbom(input: $input) {
    sbomLibs {
      id
      references {
        triggerPackage
        location
        locationLink
        dependencyType
        dependencyLevel
        commit {
          commitedAt
          committerName
          committerEmail
        }
        fileName
      }
      language
      libraryName
      libraryVersion
      license
      appName
      location
      dependencyType
      source
      appId
      locationLink
      appLink
      pkgName
      copyWriteInfo
      copyWriteInfoLink
      libLink
      vulnerabilityCounts {
        appox
        critical
        high
        medium
        low
        info
      }
      triggerPackage
      vulnerabilities {
        issueId
        oxSeverity
        severityNumberFromTool
        severityFromTool
        cve
        cveLink
        cvsVer
        cvssVersion
        epss
        percentile
        libName
        dependencyChain
        runtimeStatus
        runtimeContext {
          runtimeStatus
          cloudContexts {
            provider
            accountId
            region
            clusterName
            namespace
            containerRuntime
          }
        }
        libVersion
        chainDepth
        exploitInTheWild
        exploitInTheWildLink
        description
        dateDiscovered
        minorVerWithFix
        majorVerWithFix
        exploitRequirement
        exploitCode
        originalSeverity
      }
      latestVersion
      latestVersionDate
      stars
      forks
      openIssues
      packageManager
      purl
      packageManagerLink
      maintainers
      contributors
      downloads
      sourceLink
      notPopular
      licenseIssue
      malicious
      malwareType
      osVname
      notMaintained
      isDeprecated
      notImported
      notUpdated
      dependencyLevel
      requestId
      licenseLink
      artifactInSbomLibs {
        image
        imageLink
        imageCreatedAt
        sha
        os
        osVersion
        baseImage
        baseImageVersion
        tag
        layer
        registryName
        source
      }
      sha
      maintainersList {
        name
        email
      }
      runtimeStatus
      runtimeContext {
        runtimeStatus
        cloudContexts {
          provider
          accountId
          region
          clusterName
          namespace
          containerRuntime
        }
      }
      usedVersionReleaseDate
      projectDescription
      firstSeenDate
    }
    total
    offset
    totalFilteredSbomLibs
    cursorValue
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "input": {
    "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
    "conditionalFilters": [
      {
        "condition": "AND",
        "fieldName": "digest",
        "values": ["example"],
        "greaterThan": 13.37,
        "lessThan": 13.37
      }
    ],
    "search": "example",
    "limit": 100,
    "offset": 0,
    "sort": {
      "fields": ["LibraryName"],
      "order": ["ASC"]
    },
    "owners": ["example"],
    "tagIds": ["example"],
    "forCSV": true,
    "appPage": true,
    "cursorValue": "example"
  }
}

cURL

Node.js

Python

Arguments

You can use the following argument(s) to customize your getSbom query.

Argument	Description	Supported fields
input GetSbomInput	Parameters for filtering and paginating the SBOM libraries	scanId String conditionalFilters [ConditionalFilters] search String limit Int offset Int sort SbomLibSortInput owners [String] tagIds [String] forCSV Boolean appPage Boolean cursorValue String

Fields

Return type: SbomLibResponse

You can use the following field(s) to specify what information your getSbom query will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
sbomLibs [SbomLib]	List of SBOM libraries found in the scan	id String references [SbomReference] appType String ⚠️ language String libId String ⚠️ libraryName String libraryVersion String license String appName String location String dependencyType String source String appId String locationLink String appLink String pkgName String copyWriteInfo [String] copyWriteInfoLink String libLink String vulnerabilityCounts IssuesBySeverity triggerPackage String vulnerabilities [SCAVulnerability] latestVersion String latestVersionDate String stars Int forks Int openIssues Int packageManager String purl String packageManagerLink String maintainers Int contributors Int downloads Int sourceLink String notPopular Boolean licenseIssue Boolean malicious Boolean malwareType String osVname String notMaintained Boolean isDeprecated Boolean notImported Boolean notUsed Boolean ⚠️ notUpdated Boolean dependencyLevel Int requestId String licenseLink String artifactInSbomLibs [ArtifactInSbomLibs] sha String maintainersList [Maintainer] runtimeStatus String runtimeContext RuntimeInfo usedVersionReleaseDate String projectDescription String firstSeenDate String
total Int	Total number of libraries available
offset Int	Current pagination offset
totalFilteredSbomLibs Int	Total number of libraries after applying filters
cursorValue String	A value returned by the API that represents the position of the last item in the previous page. Use this value to paginate efficiently through the results. Pass the cursorValue from the previous API response to fetch the next page of results. If omitted, the API returns the first page.