Skip to navigation
API ReferenceContainer Registry

Download SBOM

Downloads one image’s full SBOM document as a JSON attachment (SPDX or CycloneDX). Requires scope: container-registry.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# REGISTRY_ID: Registry ID
# ARTIFACT_DIGEST: Image digest, for example `sha256:4f3c
curl "https://api.ibee.ai/v1/container-registry/registries/$REGISTRY_ID/security/sboms/$ARTIFACT_DIGEST/download?workspace_id=$WORKSPACE_ID&repository_name=<repository_name>" \
  -H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

registry_idstringRequiredformat: "uuid"
Registry ID.
artifact_digeststringRequiredformat: "^[a-z0-9_+.-]+:[A-Fa-f0-9]+$"

Image digest, for example sha256:4f3c....

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

repository_namestringRequiredformat: "^[a-z0-9]+(?:[._-][a-z0-9]+)*(?:/[a-z0-9]+(?:[._-][a-z0-9]+)*)*$"1-255 characters

Repository name inside the registry, for example api or team/api.

Response

SBOM document.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
503
Service Unavailable Error