Skip to content
GitHub

The scans of the app's current release and the gate's verdict.

GET
/api/v1/projects/{project}/environments/{environment}/apps/{app}/scans
curl --request GET \
--url https://example.com/api/v1/projects/example/environments/example/apps/example/scans
project
required
string

Project name

environment
required
string

Environment short name

app
required
string

App name

Media typeapplication/json
object
release
string | null format: uuid
gate
required

pass, warn or block: what the environment’s gate says now.

string
reasons
required
Array<string>
images
required
Array<object>
object
digest
required
string
scan
One of:
null
sbom
required

An SBOM can be downloaded.

boolean
Examplegenerated
{
"release": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"gate": "example",
"reasons": [
"example"
],
"images": [
{
"digest": "example",
"scan": {
"status": "example",
"scanner": "example",
"databaseUpdatedAt": "example",
"scannedAt": "example",
"critical": 1,
"high": 1,
"medium": 1,
"low": 1,
"unknown": 1,
"findings": [
"example"
]
},
"sbom": true
}
]
}
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
"code": "forbidden"
}