ScanopyScanopy
VLANs

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

Authorization

Authorization<token>

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

In: header

Query Parameters

group_by?|

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

order_by?|

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

order_direction?|

Direction for order_by field (group_by always uses ASC).

limit?|

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

offset?|

Number of results to skip. Default: 0.

site_ids?array<>|

Filter by site ID. Repeat the parameter to pass several.

sources?array<>|

Filter by how the VLAN came to exist (source.type). Repeat for several.

subnet_ids?array<>|

Filter to VLANs linked to one of these subnets. Repeat for several.

tag_ids?array<>|

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

tag_sets?array<string>|

Tag sets the VLAN must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.

group_by_tag_group?|

Group by the tag each row holds from this tag group. Takes the place of group_by.

order_by_tag_group?|

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

at?|

As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.

search?|

Free-text search. Case-insensitive substring match against the VLAN ID, name and description.

Response Body

text/csv

curl -X GET "https://example.com/api/v1/vlans/export/csv"
"string"

Product names and logos are trademarks of their respective owners. See credits.