Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Path Parameters

imageId
string<uuid>
required

UUID of the container image. Use the id field of an image from listContainerImages.

Body

application/json
tag
string | null

Tag to resolve and scan. Null scans the tag from the latest scan. If the image has no tag, null scans the digest from the add request.

platform
string | null

Platform to scan for multi-platform images, for example linux/amd64. Defaults to the platform stored on the image.

Response

Scan queued.

scan
object
required

One scan of a container image and the inventory that the scan recorded: resolved digest, platform, layers, image configuration, base image, and finding counts.

scan_id
string<uuid>
required

UUID of the Strix scan. Use it with the Scans endpoints.