{ "openapi": "3.0.1", "info": { "title": "Container Image SBOM and Vulnerability Scanner", "description": "Scan public images from Docker Hub, GHCR, Quay and Amazon ECR Public without a Docker daemon. Get an SBOM (CycloneDX or SPDX) and known vulnerabilities with severities and fixed versions, plus the database build date.", "version": "1.0", "x-build-id": "NyU77oKYEu5zr1bK0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jetlaunch~container-image-scanner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jetlaunch-container-image-scanner", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/jetlaunch~container-image-scanner/runs": { "post": { "operationId": "runs-sync-jetlaunch-container-image-scanner", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/jetlaunch~container-image-scanner/run-sync": { "post": { "operationId": "run-sync-jetlaunch-container-image-scanner", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "images" ], "properties": { "images": { "title": "Image references", "minItems": 1, "maxItems": 20, "type": "array", "description": "Public images as name:tag or name@sha256:digest. Examples: alpine:3.19, ghcr.io/org/app:1.2, quay.io/org/app@sha256:..., public.ecr.aws/docker/library/alpine:3.19. Supported registries: Docker Hub, GitHub Container Registry, Quay and Amazon ECR Public. Up to 20 per run. Private images and credentials are not supported.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "full", "sbom-only" ], "type": "string", "description": "Full scan returns the SBOM plus the vulnerability list (event image-scan, $0.10 per image). SBOM only returns the package list without matching vulnerabilities (event sbom-only, $0.04 per image).", "default": "full" }, "minSeverity": { "title": "Minimum severity to list", "enum": [ "all", "low", "medium", "high", "critical" ], "type": "string", "description": "Only vulnerabilities at or above this severity are listed in the vulnerabilities array. The summary counts always cover every severity so you can see what was filtered out. Ignored in SBOM-only mode.", "default": "all" }, "onlyFixable": { "title": "Only list vulnerabilities with a fix", "type": "boolean", "description": "When on, vulnerabilities for which no fixed package version is known are left out of the list. The summary counts still include them.", "default": false }, "sbomFormat": { "title": "SBOM format", "enum": [ "cyclonedx", "spdx" ], "type": "string", "description": "Format of the SBOM file saved in the key-value store.", "default": "cyclonedx" }, "platform": { "title": "Platform", "enum": [ "linux/amd64", "linux/arm64" ], "type": "string", "description": "Which variant to scan when an image is published for several CPU architectures.", "default": "linux/amd64" }, "maxPackages": { "title": "Maximum packages per image", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Safety limit. An image that contains more packages than this is reported as an error item and is not charged. Raise it for very large images.", "default": 3000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }