SCscanopy
Discoveries

List discoveries

Changed on

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.

get/api/v1/discoveries

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/discoveries
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Query parameters

site_idsstring[] nullable

Filter by site ID. Repeat the parameter to pass several.

daemon_idsstring[] nullable

Filter by daemon ID. Repeat the parameter to pass several.

idsstring[] nullable

Filter by specific entity IDs (for selective loading)

discovery_typesstring[] nullable

Only runs of one of these discovery types.

phasesDiscoveryPhase[] nullable

Only runs that ended in one of these phases (run_type.results.phase). Repeat for several. Configurations, which have no recorded outcome, never match.

historicalboolean nullable

true returns only completed runs (the history view), false only the configurations that produce them. Omit for both.

searchstring nullable

Free-text search across the discovery's name and the name of the daemon that runs it.

run_typesstring[] nullable

Only scan configurations that run one of these ways (Scheduled, AdHoc). Repeat for several.

legacyboolean[] nullable

Only configurations of a legacy type (true), a current one (false), or both (repeat it). Sent empty, matches none.

force_full_scanboolean[] nullable

Only configurations whose next run is forced to a full scan (true), not (false), or both (repeat it). Sent empty, matches none.

tag_idsstring[] nullable

Filter by tag IDs (returns discoveries that have ANY of the specified tags)

tag_setsstring[] nullable

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_tag_groupstring uuid nullable

Group by the tag each row holds from this tag group. Takes the place of group_by.

order_by_tag_groupstring uuid nullable

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

group_by'created_at' | 'name' | 'updated_at' | 'daemon_id' | 'site_id' | 'discovery_type' | 'phase' | 'started_at' | 'finished_at' | 'duration' | 'warnings' | 'run_type' | 'last_run' | 'scan_count' | 'force_full_scan' | 'legacy'

Fields that discoveries can be ordered/grouped by.

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by'created_at' | 'name' | 'updated_at' | 'daemon_id' | 'site_id' | 'discovery_type' | 'phase' | 'started_at' | 'finished_at' | 'duration' | 'warnings' | 'run_type' | 'last_run' | 'scan_count' | 'force_full_scan' | 'legacy'

Fields that discoveries can be ordered/grouped by.

Secondary ordering field (sorting within groups or standalone sort).

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

Response

List of discoveries

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Changes

  • c94279effef3Revision changes
    • breaking

      added subschema #56 to the ////////// response property oneOf list for the response status

  • 959e33713b20Revision changes
    • warning

      added the new DaemonDroppedSession enum value to the ///////////// response property for the response status

    • warning

      added the new DaemonOffline enum value to the ///////////// response property for the response status

    • warning

      added the new SessionSilent enum value to the ///////////// response property for the response status