Skip to content

List runs

GET
/api/runs
curl --request GET \
--url 'http://127.0.0.1:8765/api/runs?include_deleted=0'

Every run, newest first, with counts. Runs of a deleted profile are left out unless include_deleted=1 or profile_id names that profile.

profile_id
string

Keep the runs of this profile.

status
string

Keep the runs with this status.

limit
integer

The newest N runs (1..500).

include_deleted
string
Allowed values: 0 1

1 to include the runs of deleted profiles (hidden by default).

Success.

Media typeapplication/json
object
schema_version
required
Allowed value: scout-runs-list-response:1
key
additional properties
any
Example
{
"runs": [
{
"counts": {
"assessed": 10,
"found": 40,
"matched": 3,
"new": 12
},
"created_at": "2026-09-29T10:00:00Z",
"profile_id": "prof_1",
"run_id": "run_20260929T100000Z",
"status": "succeeded"
}
],
"schema_version": "scout-runs-list-response:1"
}

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Examplegenerated
{
"error": {
"allowed_keys": [
"example"
],
"code": "example",
"message": "example"
}
}

Not_found, target_unavailable

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
"error": {
"code": "not_found",
"message": "..."
}
}

Invalid_value

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
"error": {
"code": "invalid_value",
"message": "..."
}
}