Skip to navigation

Get vulnerability summary

Returns the number of vulnerability findings in an active registry, by severity. Requires scope: container-registry.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# REGISTRY_ID: Registry ID
curl "https://api.ibee.ai/v1/container-registry/registries/$REGISTRY_ID/security/vulnerabilities/summary?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

registry_idstringRequiredformat: "uuid"
Registry ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Summary returned.
totalinteger
Findings in total.
criticalinteger

Findings of severity Critical.

highinteger

Findings of severity High.

mediuminteger

Findings of severity Medium.

lowinteger

Findings of severity Low.

unknowninteger
Findings whose severity is unknown.
noneinteger

Findings rated None.

refreshed_atdatetime

When the counts were last computed (ISO 8601).

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
503
Service Unavailable Error