Scan the running image again
POST
/deployments/{id}/security/scan
const url = 'https://example.com/deployments/example/security/scan';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"additionalProperty":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/deployments/example/security/scan \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "additionalProperty": "example" }'Auth: authenticated (scope: deploy)
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request Body
Section titled “Request Body”Media typeapplication/json
object
key
additional properties
Example generated
{ "additionalProperty": "example"}Responses
Section titled “Responses”OK
Media typeapplication/json
object
checkedAt
required
string
image
required
object
builtAt
required
string | null
commitMessage
required
string | null
commitSha
required
string | null
digest
required
string | null
pushedAt
required
string | null
ref
required
string | null
source
required
Only images Orchard builds live in its registry and get scanned.
string
tag
required
string | null
posture
required
Array<object>
object
kind
required
string
severity
required
string
subjects
required
Array<string>
scan
required
object
canRescan
required
boolean
counts
required
object
critical
required
integer
fixable
required
integer
high
required
integer
low
required
integer
medium
required
integer
total
required
integer
unknown
required
integer
finishedAt
required
string | null
progress
required
integer | null
reason
required
Why the state is unsupported or error. An error never means no vulnerabilities.
string | null
scanner
required
object
name
required
string
version
required
string | null
startedAt
required
string | null
state
required
string
truncated
required
Findings left out after the first 500.
integer
vulnerabilities
required
Worst first. Null when the list could not be loaded or there is no finished scan.
Array<object> | null
object
cvss
required
number | null
description
required
string | null
fixVersion
required
string | null
id
required
string
package
required
string
severity
required
string
url
required
string | null
version
required
string
Example
{ "image": { "source": "orchard" }, "posture": [ { "kind": "plain-secret", "severity": "high" } ], "scan": { "reason": "external_image", "severity": "critical", "state": "clean" }, "vulnerabilities": [ { "severity": "critical" } ]}