GET /v1/getNextAvailableIP6Address - BlueCat Address Manager - 9.3.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.3.0

Description

Returns the next available IPv6 address within an IPv6 block or network.

Parameters

Name Description
parentId

Location: query

Type: integer (int64)

The object ID of IPv6 block or network where to look for the next available IPv6 address.
properties

Location: query

Type: string

The properties string contains the following properties (the properties are separated by "|"):
  • startOffset - This is optional. Specifies from which offset to retrieve the available IPv6 address. The valid values range from 0 to 2 ^ 63 (2 to the power of 63).
  • skip - This is optional. Specifies the IPv6 address ranges or IPv6 addresses to skip, separated by a comma.
  • includeDHCPRanges - This is optional. A boolean that specifies whether DHCP ranges should be included when retrieving the next available IPv6 address. The default value is false.
  • numberOfAddresses - This is optional. The number of requested IPv6 addresses. The default value is 1. The valid values are from 1 to 100. All IPv6 addresses will be returned from a single network.

Responses

Code Description
200

Type: string

Returns the next available IPv6 address in an existing network as a string of one IPv6 address or a comma separated list of IPv6 addresses if more than one address is requested.