GET /v1/getEntityByPrefix - BlueCat Address Manager - 9.2.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.2.0

Description

Returns an APIEntity for the specified IP block or network.

Parameters

Name Description
containerId

Location: query

Type: integer (int64)

The object ID of higher-level parent object IP block or configuration in which the IP block or network is located.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
prefix

Location: query

Type: string

The prefix value for the IP block or network.
type

Location: query

Type: string

The type of object to be returned. This string must be one of the constants listed in Object types.

Responses

Code Description
200

Type: APIEntity

Returns an APIEntity for the specified IPv6 block or network. The APIEntity is empty if the block or network does not exist.