---
title: "Get a list of Switch interfaces"
method: GET
path: "/network-monitoring/v1/switches/{serial-number}/interfaces"
tags: ["Switch"]
---

# Get a list of Switch interfaces

`GET /network-monitoring/v1/switches/{serial-number}/interfaces`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/switches/{serial-number}/interfaces`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-monitoring/v1/switches/:serial-number/interfaces/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `serial-number` string, const, required: The device serial number.

## Query parameters

- `limit` integer
- `offset` integer: Specifies the zero-based resource offset from which to start the response.
- `filter` string, const
- `search` string, const
- `sort` string, const

## Response `200`

Object containing the interfaces information

- SwitchInterfaceResponse: Fields appended to a list to facilitate paging.
  - `items` SwitchInterface[], required
    - `id` string, required: Interface name.
    - `name` string, required: Name of the switch interface.
    - `index` integer, required: Index of the switch interface.
    - `alias` string: Alias name for the interface.
    - `status` string, required: Operational status of the interface.
    - `errorReason` string: Reason for any error on the interface.
    - `description` string: Description of the interface.
    - `adminStatus` string, required: Administrative status of the interface.
    - `operStatus` string, required: Operational status of the interface.
    - `mtu` integer: MTU size of the interface.
    - `speed` number, float: Speed of the interface in Mbps.
    - `connector` string: Type of connector used by the interface.
    - `duplex` string: Duplex mode of the interface.
    - `lag` string: Link Aggregation Group (LAG) associated with the interface.
    - `vlanMode` string: VLAN mode of the interface.
    - `allowedVlans` string[]: List of allowed VLAN names on the interface.
    - `allowedVlanIds` integer[]: List of allowed VLAN IDs on the interface.
    - `nativeVlan` integer: Native VLAN ID of the interface.
    - `poeStatus` string: PoE (Power over Ethernet) status of the interface.
    - `poeClass` string: PoE class of the interface.
    - `portAlignment` string: Alignment status of the port.
    - `serialNumber` string: Serial number associated with the interface.
    - `peerPort` string: Name of the peer port connected to this interface.
    - `peerMemberId` integer: Member ID of the peer device.
    - `uplink` boolean: Indicates if the interface is an uplink port.
    - `type` string, required: Type of the interface.
    - `portError` string[]: List of errors associated with the port.
    - `module` string: Module number of the interface.
    - `neighbour` string: Name of the neighbouring device connected to this interface.
    - `neighbourPort` string: Port on the neighbouring device connected to this interface.
    - `neighbourFamily` string: Family of the neighbouring device.
    - `neighbourFunction` string: Function of the neighbouring device.
    - `neighbourRole` string: Role of the neighbouring device.
    - `neighbourHealth` string: Health status of the neighbouring device.
    - `neighbourSerial` string: Serial number of the neighbouring device.
    - `neighbourType` string: Type of the neighbouring device.
    - `isMultipleNeighbourClients` boolean: Indicates if the port is connected to multiple clients on the neighbouring device.
    - `transceiverType` string: Type of transceiver used in the interface.
    - `transceiverSerial` string: Serial number of the transceiver.
    - `transceiverModel` string: Model of the transceiver.
    - `transceiverProductNumber` string: Product number of the transceiver.
    - `transceiverStatus` string: Status of the transceiver.
    - `ipv4` string: IPv4 address assigned to the interface.
    - `stpInstanceType` string: Type of Spanning Tree Protocol (STP) instance.
    - `stpInstanceId` integer: Identifier of the STP instance.
    - `stpPortRole` string: Role of the port within the STP instance.
    - `stpPortState` string: State of the port within the STP instance.
    - `stpPortInconsistent` string: Indicates if there is any inconsistency in the STP port.
  - `count` integer, required: The number of objects returned in the current list.
  - `total` integer, required: The total number of objects contained in the datastore.
  - `offset` string, 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.

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `404`: Device with serial number not found.
- `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)