---
title: "List Gateway VLANs"
method: GET
path: "/network-monitoring/v1/gateways/{serial-number}/vlans"
tags: ["Gateways"]
---

# List Gateway VLANs

`GET /network-monitoring/v1/gateways/{serial-number}/vlans`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/gateways/{serial-number}/vlans`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`

Retrieves a list of VLANs present in the gateway with details like name, VLAN type, status and more.

## Path parameters

- `serial-number` string, required: The gateway serial number.

## Query parameters

- `filter` string
- `sort` string
- `limit` integer
- `next` string: Specifies the pagination cursor for the next page of resources.

## Response `200`

Object containing information about the VLANs present in the gateway.

- GatewayVlanListResponse
  - `items` object[], required
    - `vlanId` integer, required: The VLAN ID configured in the gateway.
    - `name` string: Name of the webhook. Must be unique per customer.
    - `vlanType` 'Static' | 'Dynamic': The type of VLAN configured in the gateway, either Static or Dynamic.
    - `status` 'Up' | 'Down': The status of the VLAN configured in the gateway.
    - `adminStatus` 'Up' | 'Down': The admin status of the VLAN.
    - `ipv4` string, ipv4: IP address of the VLAN.
    - `ipv4Subnet` string, ipv4: IP address of the VLAN's subnet.
    - `ipv4MaskAddr` string, ipv4: The masked IP address of the VLAN.
    - `interfaces` string: The interface to which the VLAN is assigned.
    - `id` string, required: Primary identifier for the resource.
    - `type` string, required: The type of the resource.
  - `count` integer, required: The number of items in the response.
  - `total` integer: Specifies the total number of items available for a given filter query.
  - `next` string, int32, required: Indicates the next page number, or null if there are no further pages.

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `404`: Not Found error.
- `429`: Too Many Requests. The user has sent too many requests in a given amount of time.
- `500`: Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)