import requests
url = "https://platform.ankra.app/api/v1/org/security/sbom/component"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/security/sbom/component', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/security/sbom/component \
--header 'Authorization: Bearer <token>'{
"component": {
"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
},
"images": [
{
"image_identity": "<string>",
"image_ref": "<string>",
"image_repository": "<string>",
"image_tag": "<string>",
"image_digest": "<string>",
"registry": "<string>",
"os_family": "<string>",
"os_name": "<string>",
"bom_format": "<string>",
"spec_version": "<string>",
"component_count": 123,
"dependency_count": 123,
"workloads": 123,
"clusters": 123,
"namespaces": [
"<string>"
],
"observed": 123,
"actionable": {
"critical": 123,
"high": 123,
"low": 123,
"medium": 123,
"unknown": 123
},
"known_exploited": 123,
"license_exposure": {
"network_copyleft": 123,
"source_available": 123,
"copyleft": 123,
"weak_copyleft": 123,
"permissive": 123,
"unknown": 123
},
"generated_at": "2023-11-07T05:31:56Z",
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z"
}
],
"images_capped": true,
"workloads": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"report_scope": "<string>",
"workload_kind": "<string>",
"workload_namespace": "<string>",
"workload_name": "<string>",
"container_name": "<string>",
"image_identity": "<string>",
"image_ref": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z"
}
],
"workloads_capped": true,
"clusters": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"workloads": 123,
"containers": 123,
"images": 123
}
]
}{
"detail": "<string>"
}{
"detail": "permission_denied",
"permission": "<string>",
"scope_type": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Where one package runs: the images carrying it, the workload containers running them, and their clusters
import requests
url = "https://platform.ankra.app/api/v1/org/security/sbom/component"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/security/sbom/component', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/security/sbom/component \
--header 'Authorization: Bearer <token>'{
"component": {
"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
},
"images": [
{
"image_identity": "<string>",
"image_ref": "<string>",
"image_repository": "<string>",
"image_tag": "<string>",
"image_digest": "<string>",
"registry": "<string>",
"os_family": "<string>",
"os_name": "<string>",
"bom_format": "<string>",
"spec_version": "<string>",
"component_count": 123,
"dependency_count": 123,
"workloads": 123,
"clusters": 123,
"namespaces": [
"<string>"
],
"observed": 123,
"actionable": {
"critical": 123,
"high": 123,
"low": 123,
"medium": 123,
"unknown": 123
},
"known_exploited": 123,
"license_exposure": {
"network_copyleft": 123,
"source_available": 123,
"copyleft": 123,
"weak_copyleft": 123,
"permissive": 123,
"unknown": 123
},
"generated_at": "2023-11-07T05:31:56Z",
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z"
}
],
"images_capped": true,
"workloads": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"report_scope": "<string>",
"workload_kind": "<string>",
"workload_namespace": "<string>",
"workload_name": "<string>",
"container_name": "<string>",
"image_identity": "<string>",
"image_ref": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z"
}
],
"workloads_capped": true,
"clusters": [
{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"workloads": 123,
"containers": 123,
"images": 123
}
]
}{
"detail": "<string>"
}{
"detail": "permission_denied",
"permission": "<string>",
"scope_type": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The package name as the component list shows it (case-insensitive).
The exact installed version; empty when the list shows none.
The ecosystem (apk, deb, rpm, npm, pypi, golang, maven, ...).
Only the images, workload containers and clusters on this cluster; omit for the whole fleet.
Response
Successful response
Show child attributes
Show child attributes
Images whose bill of materials names the exact package and version, most-run first, capped at 200.
Show child attributes
Show child attributes
Workload containers currently running an image that carries the component, one row per container, capped at 500; computed over every carrying image, not only the ones the images list holds when capped, and each row carries its own image identity.
Show child attributes
Show child attributes
Clusters running the component, over every carrying image.
Show child attributes
Show child attributes