> ## Documentation Index > Fetch the complete documentation index at: https://docs.app.strix.ai/llms.txt > Use this file to discover all available pages before exploring further. # Start a container image scan > Resolve the tag to a digest and queue a scan. An image whose compressed size is above the scan limit (8 GiB; self-hosted installs can change it with `STRIX_CONTAINER_MAX_IMAGE_BYTES`) fails with status 400 before Strix queues the scan. One scan per image can be queued or running at a time. Strix returns `409` when a scan is already active. Session callers must hold the admin or analyst role without asset scopes. ## OpenAPI ````yaml /openapi.json post /containers/images/{imageId}/scans openapi: 3.1.0 info: title: Strix API version: 1.0.0 description: >- Public REST API for the Strix autonomous penetration testing platform. Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks. servers: - url: /api/v1 description: Strix v1 API security: - BearerAuth: [] tags: - name: Scans description: Launch, monitor, and manage security scans. - name: Vulnerabilities description: View and triage discovered vulnerabilities. - name: Assets description: Domains and repositories registered for scanning. - name: Schedules description: Recurring scan schedules (Pro plan). - name: Search description: Search across issues, pentests, PR reviews, chats, assets and schedules. - name: Tokens description: Manage API tokens for authentication. - name: Webhooks description: Configure webhook subscriptions for real-time event notifications. - name: Organization description: Workspace configuration for the authenticated organization. - name: Members description: Manage organization members and roles. - name: Invitations description: List and revoke organization invitations. - name: PR Reviews description: Automated security review of pull requests. - name: Connectors description: Network connectors for scanning internal/private targets. - name: Knowledge description: >- Organization knowledge base: documents, policies, and repo profiles that steer the agent. - name: Uploads description: Upload source/code/documentation archives for whitebox scans. - name: Integrations description: Third-party integrations (GitLab, Bitbucket, ticketing). - name: Chat description: Conversational agent sessions. - name: Analytics description: Aggregate dashboard analytics. - name: Test Users description: >- Per-domain test accounts (with optional MFA) the agent authenticates as during scans. - name: License description: Self-hosted license state, entitlements, and aggregate usage. - name: Supply Chain description: >- SBOM inventory, supply-chain findings, scans, and policy for connected repositories. - name: CLI description: >- Device authorization endpoints that let the Strix CLI and coding agents sign in and receive an API token. - name: Billing description: Credit balance, agent-payable top-ups, and automatic top-up settings. - name: Workspaces description: List, create, and switch workspaces. - name: Asset Discovery description: >- Passive reconnaissance runs that map the organization's external attack surface, and the discovered-asset inventory they fill. - name: Containers description: >- Container registries, tracked images, image scans, findings, and SBOM components. - name: Run Logs description: Persisted engine logs and the diagnostics bundle of a self-hosted install. paths: /containers/images/{imageId}/scans: post: tags: - Containers summary: Start a container image scan description: >- Resolve the tag to a digest and queue a scan. An image whose compressed size is above the scan limit (8 GiB; self-hosted installs can change it with `STRIX_CONTAINER_MAX_IMAGE_BYTES`) fails with status 400 before Strix queues the scan. One scan per image can be queued or running at a time. Strix returns `409` when a scan is already active. Session callers must hold the admin or analyst role without asset scopes. operationId: startContainerImageScan parameters: - name: imageId in: path required: true schema: type: string format: uuid description: >- UUID of the container image. Use the `id` field of an image from `listContainerImages`. requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/StartContainerImageScanRequest' responses: '202': description: Scan queued. content: application/json: schema: $ref: '#/components/schemas/StartContainerImageScanResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalError' security: - BearerAuth: - containers:write components: schemas: StartContainerImageScanRequest: type: object properties: tag: type: - string - 'null' description: >- 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: type: - string - 'null' description: >- Platform to scan for multi-platform images, for example `linux/amd64`. Defaults to the platform stored on the image. A platform that the image index does not have fails with status 400 and the response lists the platforms the image has. An image with one manifest and no index is checked against the platform that its image config declares. required: [] StartContainerImageScanResponse: type: object properties: scan: $ref: '#/components/schemas/ContainerImageSnapshot' scan_id: type: string format: uuid description: UUID of the Strix scan. Use it with the Scans endpoints. required: - scan - scan_id ContainerImageSnapshot: type: object description: >- One scan of a container image and the inventory that the scan recorded: resolved digest, platform, layers, image configuration, base image, and finding counts. properties: id: type: string format: uuid image_id: type: string format: uuid requested_reference: type: string description: >- Reference that the caller asked Strix to scan, for example `acme/api:1.4.2`. resolved_digest: type: string platform: type: string description: OCI platform, for example `linux/amd64`. status: $ref: '#/components/schemas/ContainerScanStatus' trigger: $ref: '#/components/schemas/ContainerScanTrigger' started_at: type: string format: date-time finished_at: type: - string - 'null' format: date-time inventory_complete: type: boolean description: True when the scan produced a complete package inventory. stop_reason: type: - string - 'null' enum: - budget_exceeded - rate_limited - null description: >- Set when the run ended before the agent finished its analysis. Findings filed before the stop are kept, and the scan does not mark any finding as fixed. warnings: type: array items: type: string error: type: - string - 'null' description: Failure reason. Null unless `status` is `failed`. size_bytes: type: integer layer_count: type: integer component_count: type: integer findings: $ref: '#/components/schemas/ContainerSeverityCounts' engine: type: object properties: name: type: string version: type: string db_updated_at: type: string required: - name - version - db_updated_at base_image: type: - object - 'null' properties: reference: type: string outdated: type: boolean latest_tag: type: - string - 'null' required: - reference - outdated - latest_tag agent_scan_id: type: - string - 'null' description: >- UUID of the Strix scan that ran the exploitability pass. Use it with the Scans endpoints. required: - id - image_id - requested_reference - resolved_digest - platform - status - trigger - started_at - finished_at - inventory_complete - stop_reason - warnings - error - size_bytes - layer_count - component_count - findings - engine - base_image - agent_scan_id ErrorResponse: type: object properties: detail: type: string description: Human-readable explanation of the error. code: type: string description: >- Stable machine-readable error code. `insufficient_scope` means the token does not hold the scope that this endpoint requires. required_scope: $ref: '#/components/schemas/ApiV1Scope' description: >- Scope that the caller must add to the token. Returned with the `insufficient_scope` code. docs: type: string format: uri description: Documentation page that explains how to resolve the error. hint: type: string description: >- One instruction that resolves the error. For `insufficient_scope`, a CLI session gets the `strix cloud session scopes set full` or `strix cloud login --scope-profile full` command, and an API token gets the settings page where the user creates a token with the scope. When the owner's role cannot hold the scope, the hint asks for a role change instead. required: - detail ContainerScanStatus: type: string enum: - queued - running - completed - failed ContainerScanTrigger: type: string enum: - manual - schedule - api - registry_watch - ci ContainerSeverityCounts: type: object properties: critical: type: integer high: type: integer medium: type: integer low: type: integer total: type: integer required: - critical - high - medium - low - total ApiV1Scope: type: string enum: - scans:read - scans:write - vulnerabilities:read - vulnerabilities:write - dependencies:read - schedules:read - schedules:write - assets:read - assets:write - organizations:read - organizations:write - members:read - members:write - invitations:read - invitations:write - webhooks:read - webhooks:write - tokens:write - audit:read - pr_reviews:read - pr_reviews:write - connectors:read - connectors:write - knowledge:read - knowledge:write - uploads:write - integrations:read - integrations:write - chat:read - chat:write - scans:message - analytics:read - llm:read - llm:write - test_users:read - test_users:write - discovery:read - discovery:write - license:read - supply_chain:read - supply_chain:write - billing:read - billing:write - containers:read - containers:write - logs:read responses: BadRequest: description: Bad request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Missing or invalid API token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Insufficient permissions or missing scope. A missing scope returns the `insufficient_scope` code, the `required_scope` field, and a `hint` with the command or page that grants the scope, so a client can request the correct scope and retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Conflict: description: Conflict. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer description: >- API token obtained from the Tokens endpoint or CLI device login. Include as `Authorization: Bearer `. Requests made with a managed CLI session also include `X-Strix-Workspace: ` to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.