Skip to main content
POST
Run security scan

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app to scan.

Query Parameters

language
enum<string>
default:en

Language to return generated text in, as a lowercase two-letter code. An unsupported value is rejected with a 422.

Available options:
en,
ja,
de,
es,
fr,
pt

Response

The findings, or the state of the scan that just started.

The state of an app's security scan, and its findings when it has any.

status
string
required

Where the scan is. up_to_date means result reflects the app as it is now. out_of_date means the app changed since the last scan, so result is stale or absent. none means the app has never been scanned. pending means a scan is queued and scanning means one is running, and both can carry an earlier result while you wait. scan_failed means the last scan died, so run another.

Example:

"up_to_date"

result
SecurityScanFindings · object | null
required

What the scan found, or null when there is nothing to show. It is null on none, and also on out_of_date when the last scan came from a different version of the scanner, in which case only a fresh scan produces findings.

static_code_enabled
boolean
required

Whether code-reading analysis is switched on for this app (true) or not (false). When it is false, result.static_code_findings comes back as an empty list, so this field is the only way to tell an analysis that found nothing from one that never ran.

Example:

true