GET /v1/getIPRangedByIP - BlueCat Address Manager - 9.2.0

Address Manager API Guide

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

Description

Returns the DHCP range containing the specified IPv4 or IPv6 address. Use this method to find the configuration, IPv4 or IPv6 block, network, or DHCP range containing a specified address. You can specify the type of object to be returned, or you can leave the type of object empty to find the most direct container for the object.

Parameters

Name Description
address

Location: query

Type: string

An IPv4 or IPv6 address.
containerId

Location: query

Type: integer (int64)

The object ID of the container in which the IPv4 or IPv6 address is located. This can be a configuration, IPv4 or IPv6 block, network, or DHCP range. Specify the configuration if you don't know the block, network, or range in which the address is located.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
type

Location: query

Type: string

The type of object containing the IP address. Specify ObjectTypes.IP4Block or ObjectTypes.IP6Block, ObjectTypes.IP4Network or ObjectTypes.IP6Network, or ObjectTypes.DHCP4Range or ObjectTypes.DHCP6Range to find the block, network, or range containing the IPv4 or IPv6 address. Specify an empty string "" to return the most direct container for the IPv4 or IPv6 address.

Responses

Code Description
200

Type: APIEntity

Returns an APIEntity for the object containing the specified address.