Skip to main content
POST
Start a bulk job on findings

Authorizations

Authorization
string
header
required

JWT authentication token

Body

application/json

A bulk job on findings of your team.

kind
enum<string>
required

run starts a triage run on each finding, review applies one review action, archive and unarchive archive or restore.

Available options:
run,
review,
archive,
unarchive
selection
object
required

The findings of the job: either ids, or filter with the version of the queue the caller saw and the excluded ids. Exactly one of ids and filter.

action
object

What the job does to each finding. A review job needs review_action (and the fields that action needs, as in POST /api/v1/triage/findings/{id}/review); a run job may name a model. Archive and unarchive take nothing.

Response

The job, queued

job
object
required

A bulk job and its progress. total is the size of an id selection; for a filter selection it is an estimate until the job completes (bounded at 10,001 while the matches are read, then the exact number processed). touched + failed + skipped is the progress.