Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Switch

Get a list of Switch VLANs

This API returns a list of VLANs for the specified serial number or stack id. Conductor serial may also be used instead of a stack id

get/network-monitoring/v1/switches/{serial-number}/vlans

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial Number of the switch in case of standalone, StackId or conductor serial in case of stack for which the device related information is requested.

Query parameters

limitinteger

Denotes the number of vlans that needs to be fetched. Fetches all by default.

offsetinteger

Specifies the zero-based resource offset from which to start the response.

Example:10

Denotes the offset from where the vlans need to be fetched or the number of vlans to skip.

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

FieldOperators
statuseq and in
voiceeq and in
typeeq and in

The operators are implemented as follows:

  • eq: Only values exactly matching the given value are returned.

  • in: Only values present in the given list are returned.

searchstring const

Partial or full string free text search.

sortstring const

Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.

Supported fields are name, id, status, type, ipv4. Default sort by id.

Response

Object containing the vlans information.

countinteger required

The number of objects returned in the current list.

totalinteger required

The total number of objects contained in the datastore.

offsetstring const required

An offset which could be passed in the next query to fetch the next page. Set to null when no more pages remain.

Example response

{
  "items": [
    {
      "id": "1",
      "type": "Static",
      "name": "DEFAULT_VLAN",
      "status": "Up",
      "ipv4": "11.12.82.122/27",
      "voice": "Disabled",
      "interfaces": [
        "1-24"
      ]
    }
  ],
  "count": 1,
  "total": 1
}