Skip to main content
GET
/
scanners
/
{scanner_uid}
/
runs
List Scanner Runs
curl --request GET \
  --url https://oathnet.org/api/scanners/{scanner_uid}/runs \
  --header 'x-api-key: <api-key>'
[
  {
    "uid": "<string>",
    "status": "<string>",
    "status_display": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "duration_seconds": 123,
    "search_from": "2023-11-07T05:31:56Z",
    "search_to": "2023-11-07T05:31:56Z",
    "results_count": 123,
    "results_sample": [
      "<unknown>"
    ],
    "request_params_used": {},
    "execution_meta": {},
    "notification_sent": true,
    "notification_sent_at": "2023-11-07T05:31:56Z",
    "notification_error": "<string>",
    "error_message": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.oathnet.org/llms.txt

Use this file to discover all available pages before exploring further.

Return recent run history for one scanner.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Path Parameters

​
scanner_uid
string
required

Query Parameters

​
status
string
​
limit
integer

Response

200 - application/json

Raw array of scanner runs

​
uid
string
​
status
string
​
status_display
string
​
started_at
string<date-time>
​
completed_at
string<date-time>
​
duration_seconds
number
​
search_from
string<date-time>
​
search_to
string<date-time>
​
results_count
integer
​
results_sample
any[]
​
request_params_used
object
​
execution_meta
object
​
notification_sent
boolean
​
notification_sent_at
string<date-time>
​
notification_error
string
​
error_message
string