IPAssignment

Get all assignments

get/ip/

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/ip/
  • Auth
    API key in header X-API-KEY

Query parameters

clientIdinteger

Return IPs from this Client ID

displayIPv6boolean

Return IPv6 Addresses in Results

displayPrivateNetworksboolean

Return Private (RFC 1918) Addresses in Results

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

assignmentIdinteger

Unique ID of this assignment

broadcastIpstring

Broadcast address for this subnet.

clientIdinteger

Unique ID of the assignment owner

descriptionstring

Description for this assignment.

deviceIdinteger

The device receiving traffic from the assignment.

dnsResolversstring[]

DNS resolvers for this subnet. Only applicable to VPS instances.

facilityCodestring

Facility code of this assignment.

firstUsableIpstring

First address available for use by Devices on this subnet.

gatewayIpstring

Gateway address for this subnet.

lastUsableIpstring

Last address available for use by Devices on this subnet.

netmaskstring

Netmask for this assignment.

nextHopIpstring

Next Hop IP address, if this assignment is statically routed.

portIdinteger

The port receiving traffic from the assignment.

subnetstring

CIDR representation of this assignment.

usableIpsstring[]

A list of usable IP addresses on assignment. It is only filled for IPv4 subnets.

versioninteger required

IP version of this assignment (ipv4 or ipv6)

vlanIdinteger

The VLAN receiving traffic from the assignment.

Example response

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

Changes

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