Device

Get ports

get/device/{deviceId}/ports

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/device/{deviceId}/ports
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

clientIdinteger

Your client account's unique ID.

deviceIdinteger

The unique ID of the port's device.

mtuinteger
namestring
nativeVlanIdinteger

The unique ID of the native VLAN, if applicable.

nativeVlanTaginteger

The vlan tag of the port's native vlan, if applicable.

portIdinteger

The unique ID of the port.

privateboolean required
statusstring

ENABLED|DISABLED|UNKOWN

typestring

Indicates if is a bond interface. If not, indicates the Mbps rate of the port.

Example response

[
  {
    "ips": [
      {
        "dnsResolvers": [],
        "usableIps": []
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.