---
title: "Get ports"
method: GET
path: "/device/{deviceId}/ports"
tags: ["Device"]
---

# Get ports

`GET /device/{deviceId}/ports`

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- DevicePort[]
  - `clientId` integer — Your client account's unique ID.
  - `deviceId` integer — The unique ID of the port's device.
  - `ips` IPAssignment[] — IPs applied to this port.
    - `assignmentId` integer — Unique ID of this assignment
    - `broadcastIp` string — Broadcast address for this subnet.
    - `clientId` integer — Unique ID of the assignment owner
    - `description` string — Description for this assignment.
    - `deviceId` integer — The device receiving traffic from the assignment.
    - `dnsResolvers` string[] — DNS resolvers for this subnet. Only applicable to VPS instances.
    - `facilityCode` string — Facility code of this assignment.
    - `firstUsableIp` string — First address available for use by Devices on this subnet.
    - `gatewayIp` string — Gateway address for this subnet.
    - `lastUsableIp` string — Last address available for use by Devices on this subnet.
    - `netmask` string — Netmask for this assignment.
    - `nextHopIp` string — Next Hop IP address, if this assignment is statically routed.
    - `portId` integer — The port receiving traffic from the assignment.
    - `subnet` string — CIDR representation of this assignment.
    - `usableIps` string[] — A list of usable IP addresses on assignment. It is only filled for IPv4 subnets.
    - `version` integer, required — IP version of this assignment (ipv4 or ipv6)
    - `vlanId` integer — The VLAN receiving traffic from the assignment.
  - `mtu` integer
  - `name` string
  - `nativeVlanId` integer — The unique ID of the native VLAN, if applicable.
  - `nativeVlanTag` integer — The vlan tag of the port's native vlan, if applicable.
  - `portId` integer — The unique ID of the port.
  - `private` boolean, required
  - `status` string — ENABLED|DISABLED|UNKOWN
  - `type` string — Indicates if is a bond interface. If not, indicates the Mbps rate of the port.

## Other responses

- `403` — You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

---

[API](https://skmtc.net/hivelocity/apis/hivelocity-api.md) · [All operations](https://skmtc.net/hivelocity/apis/hivelocity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hivelocity/hivelocity-api/revisions/ee6b717b5015/schema)
