Sign in

v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB
Discoveries

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.

get/api/v1/discovery

Query parameters

network_idstring uuid nullable

Filter by network ID

daemon_idstring uuid nullable

Filter by daemon ID

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.

group_by'created_at' | 'name' | 'updated_at' | 'daemon_id' | 'network_id' | 'discovery_type'

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' | 'network_id' | 'discovery_type'

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.

Example response

{
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.17.7"
  }
}