SCscanopy
Daemons

List daemons

Changed on

Returns all daemons accessible to the user. Supports pagination via limit and offset query parameters, and ordering via group_by, order_by, and order_direction.

get/api/v1/daemons

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/daemons
  • 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.

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

List of daemons

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

{
  "data": [
    {
      "url": "https://daemon.example.com:60073",
      "version": "0.17.7"
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.19.4"
  }
}

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api operation id get_daemons removed and replaced with list_daemons

  • c9f50be8bc26Revision changes
    • warning

      deleted the query request parameter site_id

    • info

      added the new optional query request parameter group_by_tag_group

    • info

      added the new optional query request parameter interfaced_subnet_ids

    • info

      added the new optional query request parameter maintainer_ids

    • info

      added the new optional query request parameter modes

    • info

      added the new optional query request parameter order_by_tag_group

    • info

      added the new optional query request parameter os

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter site_ids

    • info

      added the new optional query request parameter statuses

    • info

      added the new optional query request parameter tag_ids

    • info

      added the new optional query request parameter tag_sets

    • info

      added the new optional query request parameter versions

    • info

      added the enum value maintainer to the property oneOf[DaemonOrderField]/ of the query request parameter group_by

    • info

      added the enum value maintainer to the property oneOf[DaemonOrderField]/ of the query request parameter order_by

    • info

      added the enum value mode to the property oneOf[DaemonOrderField]/ of the query request parameter group_by

    • info

      added the enum value mode to the property oneOf[DaemonOrderField]/ of the query request parameter order_by

    • info

      added the enum value os to the property oneOf[DaemonOrderField]/ of the query request parameter group_by

    • info

      added the enum value os to the property oneOf[DaemonOrderField]/ of the query request parameter order_by

    • info

      added the enum value status to the property oneOf[DaemonOrderField]/ of the query request parameter group_by

    • info

      added the enum value status to the property oneOf[DaemonOrderField]/ of the query request parameter order_by

    • info

      added the enum value version to the property oneOf[DaemonOrderField]/ of the query request parameter group_by

    • info

      added the enum value version to the property oneOf[DaemonOrderField]/ of the query request parameter order_by

    • info

      added the required property /// to the response with the status