Sign in
Hosts

Export hosts with children to ZIP

Exports all hosts matching the filter criteria along with their children (ip_addresses, ports, services, interfaces) as a ZIP archive containing separate CSV files for each entity type.

get/api/v1/hosts/export/zip

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)

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

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'

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.

Response

ZIP file containing CSVs

Changes