Images with a bill of materials
import requests
url = "https://platform.ankra.app/api/v1/org/security/sbom/images"
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/images', 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/images \
--header 'Authorization: Bearer <token>'{
"result": [
{
"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,
"generated_at": "2023-11-07T05:31:56Z",
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page": 123,
"page_size": 123,
"total_count": 123,
"total_pages": 123
},
"coverage": {
"scanned_clusters": 123,
"clusters_with_sbom": 123,
"images": 123,
"components": 123,
"workloads": 123,
"latest_generated_at": "2023-11-07T05:31:56Z"
}
}{
"detail": "<string>"
}{
"detail": "permission_denied",
"permission": "<string>",
"scope_type": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}security
Images with a bill of materials
Every image with a stored bill of materials: OS, component count, the workloads, clusters and namespaces running it, and the actionable findings the scanner attributes to it.
GET
/
api
/
v1
/
org
/
security
/
sbom
/
images
Images with a bill of materials
import requests
url = "https://platform.ankra.app/api/v1/org/security/sbom/images"
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/images', 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/images \
--header 'Authorization: Bearer <token>'{
"result": [
{
"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,
"generated_at": "2023-11-07T05:31:56Z",
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page": 123,
"page_size": 123,
"total_count": 123,
"total_pages": 123
},
"coverage": {
"scanned_clusters": 123,
"clusters_with_sbom": 123,
"images": 123,
"components": 123,
"workloads": 123,
"latest_generated_at": "2023-11-07T05:31:56Z"
}
}{
"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
Required range:
1 <= x <= 10000Values above 100 are clamped to 100.
Required range:
x >= 1Available options:
image_ref, components, workloads, clusters, actionable, known_exploited, generated_at, last_seen_at Available options:
asc, desc