SCscanopy
VLANs

Export VLANs to CSV

Changed on

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

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/vlans/export/csv
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Query parameters

group_by'created_at' | 'name' | 'vlan_number' | 'updated_at' | 'site_id' | 'source' | 'last_seen_at'

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

order_by'created_at' | 'name' | 'vlan_number' | 'updated_at' | 'site_id' | 'source' | 'last_seen_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.

site_idsstring[] nullable

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

sourcesEntitySourceDiscriminants[] nullable

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

subnet_idsstring[] nullable

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

tag_idsstring[] nullable

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

tag_setsstring[] nullable

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_groupstring uuid nullable

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

order_by_tag_groupstring uuid nullable

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

atstring date-time nullable

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

searchstring nullable

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

Response

CSV file containing VLANs

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api tag VLANs added

    • info

      api tag Vlans removed

  • c9f50be8bc26Revision changes
    • warning

      deleted the query request parameter site_id

    • info

      added the new optional query request parameter group_by_tag_group

    • info

      added the new optional query request parameter order_by_tag_group

    • info

      added the new optional query request parameter site_ids

    • info

      added the new optional query request parameter sources

    • info

      added the new optional query request parameter subnet_ids

    • info

      added the new optional query request parameter tag_ids

    • info

      added the new optional query request parameter tag_sets

    • info

      added the enum value last_seen_at to the property oneOf[VlanOrderField]/ of the query request parameter group_by

    • info

      added the enum value last_seen_at to the property oneOf[VlanOrderField]/ of the query request parameter order_by

    • info

      added the enum value site_id to the property oneOf[VlanOrderField]/ of the query request parameter group_by

    • info

      added the enum value site_id to the property oneOf[VlanOrderField]/ of the query request parameter order_by

    • info

      added the enum value source to the property oneOf[VlanOrderField]/ of the query request parameter group_by

    • info

      added the enum value source to the property oneOf[VlanOrderField]/ of the query request parameter order_by