GET /v1/getNextAvailableIP4Network - BlueCat Address Manager - 9.1.0

Address Manager API Guide

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

Description

Returns the object ID for the next available (unused) network within a configuration or block.

Parameters

Name Description
autoCreate

Location: query

Type: boolean

This Boolean value indicates whether the next available network should be created if it does not exist.
isLargerAllowed

Location: query

Type: boolean

This Boolean value indicates whether to return larger networks than those specified with the size parameter.
parentId

Location: query

Type: integer (int64)

The object ID of the network’s parent object.
size

Location: query

Type: integer (int64)

The size of the network, expressed as a power of 2. The size represents the number of hosts on the network. For example, if you are to find or create a /24 network, the size would be 256.

Responses

Code Description
200

Type: number

Returns the object ID for the existing next available IPv4 network or, if the next available network did not exist and autoCreate was set to true, the newly created IPv4 network.