Skip to content

Image and runtime scanning

Vulnerability scanning of images and running containers, its policies and its findings.

Every address below is served under the control plane’s base URL. Permission is the guard the route is registered with; who holds it is read from the control plane’s own grant, so it cannot drift from what the server does. A dash means the route carries no permission guard of its own — the access tier below the table is then the whole of what stands in front of it.

Generated from Route. Hand edits to this table are overwritten on the next build — change the Go doc comment, or the generator.

Route Permission Who holds it Body
GET /api/v1/scanner/backends scanner:read operator, support
GET /api/v1/scanner/deployments/{name} scanner:read operator, support
POST /api/v1/scanner/deployments/{name}/upgrade scanner:upgrade operator
GET /api/v1/scanner/deployments/{name}/upgrades scanner:read operator, support
POST /api/v1/scanner/evaluate scanner:read operator, support
GET /api/v1/scanner/images/{image}/latest scanner:read operator, support
GET /api/v1/scanner/images/{image}/upgrades scanner:read operator, support
GET /api/v1/scanner/policies scanner:read operator, support
POST /api/v1/scanner/policies scanner:manage operator
POST /api/v1/scanner/policies/test scanner:read operator, support
DELETE /api/v1/scanner/policies/{name} scanner:manage operator
GET /api/v1/scanner/policies/{name} scanner:read operator, support
PUT /api/v1/scanner/policies/{name} scanner:manage operator
POST /api/v1/scanner/policies/{name}/override scanner:manage operator
GET /api/v1/scanner/policies/{name}/overrides scanner:read operator, support
POST /api/v1/scanner/policies/{name}/overrides/{id}/approve admin an administrator only, through the wildcard grant
GET /api/v1/scanner/remediation/{image} scanner:read operator, support
GET /api/v1/scanner/results scanner:read operator, support
GET /api/v1/scanner/results/{scanId} scanner:read operator, support
POST /api/v1/scanner/scan scanner:scan operator
GET /api/v1/scanner/settings
PUT /api/v1/scanner/settings
GET /api/v1/scanner/stats scanner:read operator, support
POST /api/v1/scanner/update-db scanner:manage operator
GET /api/v1/scanner/vulnerabilities scanner:read operator, support
GET /api/v1/scanner/vulnerabilities/{cve} scanner:read operator, support

authenticated — Behind authentication, cross-site-request-forgery validation and tenant extraction. Every call acts inside exactly one tenant.

platform-operator — Platform-operator surface, across tenants. Not part of a tenant’s own API.

No role holds the permissions below explicitly. They are satisfied by the administrator’s wildcard grant and by nothing else, so an operator or a developer cannot call these routes however their tenant is configured. That is a role-model question rather than a documentation one; it is recorded here because a reader planning around it needs to know before they try.

  • POST /api/v1/scanner/policies/{name}/overrides/{id}/approve — needs admin