List discoveries
Returns discoveries the authenticated user has access to. The run history grows without bound, so this is paginated and ordered server-side rather than filtered in the browser.
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Query Parameters
Filter by site ID. Repeat the parameter to pass several.
Filter by daemon ID. Repeat the parameter to pass several.
Filter by specific entity IDs (for selective loading)
Only runs of one of these discovery types.
Only runs that ended in one of these phases (run_type.results.phase). Repeat for
several. Configurations, which have no recorded outcome, never match.
true returns only completed runs (the history view), false only the
configurations that produce them. Omit for both.
Free-text search across the discovery's name and the name of the daemon that runs it.
Only scan configurations that run one of these ways (Scheduled, AdHoc). Repeat for
several.
Only configurations of a legacy type (true), a current one (false), or both (repeat
it). Sent empty, matches none.
Only configurations whose next run is forced to a full scan (true), not (false), or
both (repeat it). Sent empty, matches none.
Filter by tag IDs (returns discoveries that have ANY of the specified tags)
Tag sets the discovery must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.
Group by the tag each row holds from this tag group. Takes the place of group_by.
Sort by the position of the tag each row holds from this tag group. Takes the place of
order_by.
Primary ordering field (used for grouping). Always sorts ASC to keep groups together.
Secondary ordering field (sorting within groups or standalone sort).
Direction for order_by field (group_by always uses ASC).
Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.
Number of results to skip. Default: 0.
Response Body
application/json
curl -X GET "https://example.com/api/v1/discoveries"{
"data": [
{
"daemon_id": "0f0cd6bf-ac90-457b-aa3f-6f24990d5ff6",
"discovery_type": {
"host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",
"type": "SelfReport"
},
"name": "string",
"run_type": {
"cron_schedule": "string",
"enabled": true,
"type": "Scheduled",
"last_run": "2019-08-24T14:15:22Z",
"timezone": "string"
},
"site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
"tags": [
"a424dc99-d215-4281-ad2d-a3a9bc179925"
],
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"integration_targets": [
{
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"scope": "DaemonHost"
}
],
"updated_at": "2019-08-24T14:15:22Z",
"force_full_scan": true,
"next_run_is_full_scan": true,
"scan_count": 0
}
],
"meta": {
"api_version": 1,
"pagination": {
"has_more": true,
"limit": 50,
"offset": 0,
"total_count": 142
},
"server_version": "0.19.6"
},
"success": true,
"error": "string"
}Product names and logos are trademarks of their respective owners. See credits.
List active discovery sessions
Previous Page
Cancel discovery sessions
Cancels the running session of each discovery, given discovery IDs. Sessions still queued are cancelled before running ones, so cancelling a running session never starts a queued one that is also being cancelled. The request is refused, and nothing is cancelled, if any discovery isn't running or its session is just starting on its daemon.