Skip to main content

Queue a new SBOM scan for a docker image, binary file, or directory

POST 
/api/v1/sbom/scans

Queue a new SBOM scan for a docker image, binary file, or directory

Request​

Body

required

    target stringrequired

    Scan target (image name, file path, registry URL, etc.)

    targetType stringrequired

    Possible values: [docker, registry, file, dir, oci-archive]

    Type of the scan target

    format string

    Possible values: [syft-json, spdx-json, cyclonedx-json, table, text]

    Default value: cyclonedx-json

    SBOM output format

    triggeredBy string

    Who or what triggered this scan (user ID, service name, etc.)

    isStoredInBucket boolean

    Set to true when target is a raw object key inside the MinIO bucket (e.g. upload/release/1/file.msi). sbom-generator will generate a fresh presigned URL at execution time. Required for file retries to work correctly.

Responses​

Scan queued successfully, returns scanId

Loading...