v62
latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KBVlans
Export Vlans to CSV
Export all Vlans matching the filter criteria to CSV format. Ignores pagination parameters (limit/offset) and exports all matching records.
get/api/v1/vlans/export/csv
Query parameters
group_by'created_at' | 'name' | 'vlan_number' | 'updated_at'
Primary ordering field (used for grouping). Always sorts ASC to keep groups together.
order_by'created_at' | 'name' | 'vlan_number' | 'updated_at'
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.
network_idstring uuid nullable
Filter by network ID
atstring date-time nullable
As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.
Response
CSV file containing Vlans