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

# Get Switch details

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

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/switches/{serial-number}`
- 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/get.ts> (a function with typed inputs; its response is checked against the schema)

This API retrieves current switch information for the specified serial number or stack id. Conductor serial may also be used instead of a stack id. In the case of stacked switches, logical switch details and trend data are also provided. Member-level information can be obtained using the listStackMember API.

## Path parameters

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

## Response `200`

Object containing the switch information

- SwitchResponse: Switch response that contains switch attributes
  - `id` string, const, required: Serial of the switch.
  - `type` string, const, required: API type.
  - `switchLinkType` string: Link type for switch
  - `switchType` string: Type of the switch, e.g., pvos or cx
  - `serialNumber` string, const
  - `ipv4` string: The switch IP address in IPv4 format
  - `status` string: The status of the switch
  - `ipv6` string: The switch IP address in IPv6 format
  - `macAddress` string: The MAC address of the switch
  - `publicIp` string: Public IP address of the switch
  - `model` string: Model of the switch
  - `health` string: Health status of the switch
  - `siteName` string: SiteName
  - `healthReasons` SwitchHealthReasons
    - `poorReasons` string[], required: List of reasons why the switch health is considered poor
    - `fairReasons` string[], required: List of reasons why the switch health is considered fair
    - `primaryReason` SwitchHealthPrimaryReason, required
      - `reasonEnum` string: Health Primary Reason Enum.
      - `typeId` string: Health Primary Reason TypeId.
      - `totalReasons` integer: Total health reasons.
  - `siteId` string, const
  - `uptimeInMillis` number, float: The elapsed time in milliseconds since the last boot.
  - `firmwareVersion` string: Current firmware version of the switch
  - `deployment` string: Deployment mode of the switch
  - `jNumber` string: Job number or identifier
  - `lastSeenAt` number, float: Timestamp when the switch was last seen online
  - `deviceName` string: Name of the switch
  - `switchRole` string: Role of the switch in the network
  - `manufacturer` string: Manufacturer of the switch
  - `lastConfigChange` number, float: Timestamp of the last configuration change
  - `lastRestartReason` string: Reason for the last restart
  - `switchTrends` SwitchTrends
    - `serialNumber` string, const
    - `switchRole` string: Role of the switch.
    - `cpuUtilization` number: CPU Utilization of the switch.
    - `memoryUtilization` number: Memory Utilization of the switch.
    - `poeAvailable` number: Total Poe available.
    - `poeConsumption` number: Poe drawn.
    - `powerConsumption` number: Total power available.
    - `totalPowerConsumption` number: Total power consumed.
    - `systemTemperature` number: Temperature of the switch.
    - `upLinkPorts` string: Uplink ports for the switch.
    - `usage` number: Total sum of the inrate and outrate for the switch.

## 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)