ScanopyScanopy
Hosts

Export hosts with children to ZIP

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

GET
/api/v1/hosts/export/zip

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Query Parameters

network_id?string|null

Filter by network ID

Formatuuid
ids?|null

Filter by specific entity IDs (for selective loading)

tag_ids?|null

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

group_by?null|HostOrderField

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

order_by?null|HostOrderField

Secondary ordering field (sorting within groups or standalone sort).

order_direction?null|OrderDirection

Direction for order_by field (group_by always uses ASC).

limit?integer|null

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

Formatint32
Range0 <= value <= 1000
offset?integer|null

Number of results to skip. Default: 0.

Formatint32
Range0 <= value

Response Body

application/zip

curl -X GET "https://loading/api/v1/hosts/export/zip"
Empty

Export Hosts to CSV

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

List all hosts

Returns all hosts the authenticated user has access to, with their interfaces, ports, and services included. Supports pagination via `limit` and `offset` query parameters, and ordering via `group_by`, `order_by`, and `order_direction`.