Containers

Add a container image

Resolve the reference to a digest, track the image, and start the first scan unless scan is false. 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 tracks it. When the image is already tracked, Strix returns it with created false and a 200 status. Session callers must hold the admin or analyst role without asset scopes. Container scanning requires the Enterprise plan.

POST

containers

images

Error

A valid request URL is required to generate request examples

{
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "registry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "latest_tag": "<string>",
    "latest_digest": "<string>",
    "platform": "<string>",
    "linked_repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linked_repository_name": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "queued",
    "findings": {
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123,
      "total": 123
    },
    "reachable_count": 123,
    "secret_count": 123,
    "misconfiguration_count": 123,
    "deployed": true,
    "watch_tags": "<string>"
  },
  "created": true,
  "resolved": {
    "tag": "<string>",
    "digest": "<string>",
    "platform": "<string>"
  },
  "scan": {
    "image_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "scan_error": "<string>"
}

{
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "registry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "latest_tag": "<string>",
    "latest_digest": "<string>",
    "platform": "<string>",
    "linked_repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linked_repository_name": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "queued",
    "findings": {
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123,
      "total": 123
    },
    "reachable_count": 123,
    "secret_count": 123,
    "misconfiguration_count": 123,
    "deployed": true,
    "watch_tags": "<string>"
  },
  "created": true,
  "resolved": {
    "tag": "<string>",
    "digest": "<string>",
    "platform": "<string>"
  },
  "scan": {
    "image_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "scan_error": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

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.

Body

application/json

registry_id

string<uuid>

required

Connected registry that hosts the image. Connect a registry first, with or without credentials.

reference

string

required

Image reference in the form name:tag or name@sha256:<digest>, without the registry host.

platform

string | null

OCI platform to add, for example linux/amd64. Null selects linux/amd64 when the image has it, else the first platform in the index. A platform that you set explicitly must exist in the image index: if it does not, the request 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. A later scan of the image uses the stored platform if the scan request does not specify a platform.

linked_repository_id

string<uuid> | null

Repository that builds this image. Strix shows the link on the image and uses it for remediation context.

watch_tags

string | null

Tag pattern to watch, for example 1.* or release-*. When set, Strix rescans the image when a matching tag moves to a new digest.

scan

boolean

default:false

Start the first scan when the image is added. Default false.

Response

The image was already tracked.

image

object

required

A tracked container image with counts from its latest completed scan.

Show child attributes

created

boolean

required

False when the image was already tracked.

resolved

object

required

Show child attributes

scan

object | null

required

Show child attributes

scan_error

string | null

required

Reason the first scan did not start. Null when scan is set or the caller disabled the scan.

Error

A valid request URL is required to generate request examples

{
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "registry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "latest_tag": "<string>",
    "latest_digest": "<string>",
    "platform": "<string>",
    "linked_repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linked_repository_name": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "queued",
    "findings": {
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123,
      "total": 123
    },
    "reachable_count": 123,
    "secret_count": 123,
    "misconfiguration_count": 123,
    "deployed": true,
    "watch_tags": "<string>"
  },
  "created": true,
  "resolved": {
    "tag": "<string>",
    "digest": "<string>",
    "platform": "<string>"
  },
  "scan": {
    "image_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "scan_error": "<string>"
}

{
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "registry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "latest_tag": "<string>",
    "latest_digest": "<string>",
    "platform": "<string>",
    "linked_repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linked_repository_name": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "queued",
    "findings": {
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123,
      "total": 123
    },
    "reachable_count": 123,
    "secret_count": 123,
    "misconfiguration_count": 123,
    "deployed": true,
    "watch_tags": "<string>"
  },
  "created": true,
  "resolved": {
    "tag": "<string>",
    "digest": "<string>",
    "platform": "<string>"
  },
  "scan": {
    "image_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "scan_error": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Repositories

Add a container image

Authorizations

Body

Response