---
title: "Export hosts with children to ZIP"
method: GET
path: "/api/v1/hosts/export/zip"
tags: ["Hosts"]
---

# Export hosts with children to ZIP

`GET /api/v1/hosts/export/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.

## Query parameters

- `network_id` string, uuid, nullable
- `ids` string[], nullable
- `tag_ids` string[], nullable
- `search` string, nullable
- `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.
- `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.
- `order_direction` 'asc' | 'desc' — Direction for ORDER BY clauses.
- `limit` integer, nullable
- `offset` integer, nullable
- `at` string, date-time, nullable
- `stale` boolean, nullable
- `include_children` boolean, nullable

## Response `200`

ZIP file containing CSVs

## Changes

- **2026-07-29** `49ea97c8bb7e` — 1 info
  - added the new optional `query` request parameter `search`
- **2026-07-29** `252836288740` — 1 info
  - added the new optional `query` request parameter `include_children`
- **2026-07-22** `8d79aa9841a2` — 3 info
  - added the new optional `query` request parameter `stale`
  - added the enum value `last_seen_at` to the property `oneOf[#/components/schemas/HostOrderField]/` of the `query` request parameter `group_by`
  - added the enum value `last_seen_at` to the property `oneOf[#/components/schemas/HostOrderField]/` of the `query` request parameter `order_by`
- **2026-06-11** `aac398d6764d` — 1 info
  - added the new optional `query` request parameter `at`
- **2026-06-11** `c7bad4e3d772` — 1 warning
  - deleted the `query` request parameter `at`

[Full history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/hosts/export/zip/get.md)

---

[API](https://skmtc.dev/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.dev/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/d061209476f3/schema)