The fleet's software bill of materials

Every package the scanner found in the fleet’s container images, grouped by name, version and ecosystem, with how many images, workloads and clusters carry it and the findings that name that exact package and version on those images. The coverage block says how many scanned clusters publish a bill of materials; the rest have SBOM generation switched off.

GET /org/security/sbom

The fleet's software bill of materials

Python

import requests

url = "https://platform.ankra.app/org/security/sbom"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "result": [
    {
      "name": "<string>",
      "version": "<string>",
      "package_type": "<string>",
      "component_type": "<string>",
      "purl": "<string>",
      "licenses": [
        "<string>"
      ],
      "license_risk": "network_copyleft",
      "images": 123,
      "workloads": 123,
      "clusters": 123,
      "vulnerable_findings": 123,
      "actionable_findings": 123,
      "known_exploited": 123
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total_count": 123,
    "total_pages": 123
  },
  "facets": {
    "package_type": [
      {
        "count": 123,
        "value": "<string>"
      }
    ],
    "license_risk": [
      {
        "count": 123,
        "value": "<string>"
      }
    ]
  },
  "coverage": {
    "scanned_clusters": 123,
    "clusters_with_sbom": 123,
    "images": 123,
    "components": 123,
    "workloads": 123,
    "latest_generated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · integer · default: 1

Required range: 1 <= x <= 10000

page_size · integer · default: 50

Values above 100 are clamped to 100.

Required range: x >= 1

search · string

package_type · string[]

Ecosystem filter, repeatable (deb, apk, rpm, npm, pypi, golang, maven, ...).

license_risk · string[]

Only components in these licence tiers (network_copyleft, source_available, copyleft, weak_copyleft, permissive, unknown); repeat or comma-separate to combine.

cluster_id · string<uuid>

namespace · string

workload_kind · string

Only images running in workloads of this kind (Deployment, StatefulSet, DaemonSet, CronJob, ...); case-insensitive.

workload_name · string

Only images running in the workload with this name; case-insensitive. Combine with workload_kind to pin one workload.

image · string

Only components inside one image (digest or repository:tag identity).

vulnerable · boolean

true keeps components a finding names, false the ones nothing names.

sort · enum<string> · default: images

Available options: name, version, package_type, images, workloads, clusters, vulnerable, actionable

order · enum<string> · default: desc

Available options: asc, desc

Response

200

application/json

Successful response

result · SecuritySbomComponentSummary · object[] · required

Show child attributes

pagination · object · required

Show child attributes

facets · SecuritySbomComponentFacets · object · required

Show child attributes

coverage · SecuritySbomCoverage · object · required

Show child attributes