Sign in

v62

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

Export Hosts to CSV

Export all Hosts matching the filter criteria to CSV format. Ignores pagination parameters (limit/offset) and exports all matching records.

get/api/v1/hosts/export/csv

Query parameters

network_idstring uuid nullable

Filter by network ID

idsstring[] nullable

Filter by specific entity IDs (for selective loading)

tag_idsstring[] nullable

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

searchstring nullable

Free-text search. Case-insensitive substring match against the host's name, hostname and description, and against its IP addresses and the names of services running on it.

group_by'created_at' | 'name' | 'hostname' | 'updated_at' | 'virtualized_by' | 'network_id' | 'interface_ip' | 'last_seen_at'

Fields that hosts can be ordered/grouped by.

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

order_by'created_at' | 'name' | 'hostname' | 'updated_at' | 'virtualized_by' | 'network_id' | 'interface_ip' | 'last_seen_at'

Fields that hosts 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.

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 hosts discovery hasn't observed within their network's staleness window; false returns only those it has. Omit for both. Evaluated per row against the host's own network's window.

include_childrenboolean nullable

false returns hosts with empty ip_addresses/ports/services/ interfaces. The children dominate the payload, so callers that only need host identity — name pickers, id→name lookups, counts — should pass false. Defaults to true, so existing callers are unaffected.

Response

CSV file containing Hosts