Sign in
Vlans

List all VLANs

Returns VLANs accessible to the authenticated user, optionally filtered by network.

get/api/v1/vlans

Query parameters

group_by'created_at' | 'name' | 'vlan_number' | 'updated_at'
order_by'created_at' | 'name' | 'vlan_number' | 'updated_at'
order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

limitinteger nullable
offsetinteger nullable
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

List of VLANs

errorstring nullable
successboolean required

Example response

{
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.17.7"
  }
}

Changes