SCscanopy
Daemons
internal

List daemon field values

Changed on

Every distinct value of one Daemon field across the Daemons the caller can list, with how many hold each. Takes the list's filters; ignores pagination, search and ordering.

get/api/v1/daemons/field-values/{field}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/daemons/field-values/{field}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

field'created_at' | 'name' | 'last_seen' | 'updated_at' | 'site_id' | 'os' | 'mode' | 'maintainer' | 'version' | 'status' required

Fields that daemons can be ordered/grouped by.

The field whose values to count

Query parameters

site_idsstring[] nullable

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

statusesDaemonHealth[] nullable

Only daemons in one of these statuses. Repeat for several.

osDaemonOs[] nullable

Only daemons installed on one of these operating systems. Repeat for several.

modesDaemonMode[] nullable

Only daemons that connect one of these ways. Repeat for several.

maintainer_idsstring[] nullable

Only daemons maintained by one of these users. Repeat for several.

versionsstring[] nullable

Only daemons running one of these versions. Repeat for several.

interfaced_subnet_idsstring[] nullable

Only daemons with an interface on one of these subnets. Repeat for several.

tag_idsstring[] nullable

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

tag_setsstring[] nullable

Tag sets the daemon 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.

searchstring nullable

Free-text search. Case-insensitive substring match against the name and url.

group_by'created_at' | 'name' | 'last_seen' | 'updated_at' | 'site_id' | 'os' | 'mode' | 'maintainer' | 'version' | 'status'

Fields that daemons can be ordered/grouped by.

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

order_by'created_at' | 'name' | 'last_seen' | 'updated_at' | 'site_id' | 'os' | 'mode' | 'maintainer' | 'version' | 'status'

Fields that daemons can be ordered/grouped by.

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

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.

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

Distinct values and their Daemon counts

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes