Scan Status

POST {{cb_url}}/containers/v1beta/orgs/{{cb_org_key}}/inventory/overview/scan_status

Returns the number of deployed images in each possible scan status.

RBAC Permissions Required

Permission (.notation name)	Operation(s)
workloads.container.image	READ

API Documentation

Request Schema

{
  "criteria": {
    "clusters": [
      "<string>"
    ],
    "namespaces": [
      "<string>"
    ],
    "repositories": [
      "<string>"
    ]
  }
}

Response Schema

{
  "SCANNED": <integer>,
  "NOT_SCANNED": <integer>,
  "SCANNING": <integer>,
  "SCAN_FAILED": <integer>,
  "PENDING_SCAN": <integer>,
  "SCAN_ABORTED": <integer>
}

Request Body

{"clusters"=>["demo:cluster-one", "test:testing-cluster-one"], "namespaces"=>["demo-namespace", "testing-namespace"], "repositories"=>["demoartifactory/cluster-scanner", "demoartifactory/guardrails-enforcer"]}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`Accept`	string

RESPONSES

status: OK

{&quot;NOT_SCANNED&quot;:14,&quot;SCANNED&quot;:72,&quot;SCAN_FAILED&quot;:1}