Sign in

v62

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

List all services

Returns all services the authenticated user has access to. Supports pagination via limit and offset query parameters, and ordering via group_by, order_by, and order_direction.

get/api/v1/services

Query parameters

network_idstring uuid nullable

Filter by network ID

host_idstring uuid nullable

Filter by host ID

idsstring[] nullable

Filter by specific entity IDs (for selective loading)

tag_idsstring[] nullable

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

searchstring nullable

Free-text search. Case-insensitive substring match against the service's name and definition, and against the name of the host it runs on.

group_by'created_at' | 'name' | 'updated_at' | 'host' | 'network_id' | 'position' | 'service_definition' | 'last_seen_at'

Fields that services 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' | 'host' | 'network_id' | 'position' | 'service_definition' | 'last_seen_at'

Fields that services 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).

portsinteger[] nullable

Only services exposed on one of these port numbers, over either protocol.

exclude_categoriesServiceCategory[] nullable

Exclude services belonging to these categories.

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.

atstring date-time nullable

As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.

staleboolean nullable

true returns only services discovery hasn't observed within their network's staleness window; false returns only those it has. Omit for both. Evaluated per row against the service's own network's window.

Response

List of services

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": [
    {
      "bindings": [
        {
          "created_at": "2026-07-29T15:23:06.667799Z",
          "first_discovery_id": null,
          "id": "4fda6a99-00cc-4d78-8168-30f365a51990",
          "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
          "last_discovery_id": null,
          "last_seen_at": "2026-07-29T15:23:06.667799Z",
          "lineage_id": null,
          "network_id": "550e8400-e29b-41d4-a716-446655440002",
          "port_id": "550e8400-e29b-41d4-a716-446655440006",
          "service_id": "550e8400-e29b-41d4-a716-446655440007",
          "type": "Port",
          "updated_at": "2026-07-29T15:23:06.667799Z",
          "valid_from": "2026-07-29T15:23:06.667799Z",
          "valid_to": null
        }
      ],
      "created_at": "2026-01-15T10:30:00Z",
      "first_discovery_id": null,
      "host_id": "550e8400-e29b-41d4-a716-446655440003",
      "id": "550e8400-e29b-41d4-a716-446655440007",
      "last_discovery_id": null,
      "last_seen_at": "2026-01-15T10:30:00Z",
      "lineage_id": null,
      "name": "nginx",
      "network_id": "550e8400-e29b-41d4-a716-446655440002",
      "position": 0,
      "service_definition": "Unclaimed Open Ports",
      "source": {
        "type": "Manual"
      },
      "tags": [],
      "updated_at": "2026-01-15T10:30:00Z",
      "valid_from": "2026-01-15T10:30:00Z",
      "valid_to": null,
      "virtualization": null
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.17.7"
  }
}