GET /v1/getIP6ObjectsByHint - BlueCat Address Manager - 9.1.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.1.0

Description

Returns an array of IPv6 objects found under a given container object. The networks can be filtered by using ObjectProperties.hint and ObjectProperties.accessRight options. Currently, it only supports IPv6 networks.

Parameters

Name Description
containerId

Location: query

Type: integer (int64)

The object ID for the container object. It can be the object ID of any object in the parent object hierarchy. The highest parent object is the configuration level.
count

Location: query

Type: integer (int32)

Indicates the maximum number of child objects that this method will return.
objectType

Location: query

Type: string

The type of object containing the IPv6 network. Currently, it only supports ObjectTypes.IP6Network.
options

Location: query

Type: string

A string containing options. The Option names available in ObjectProperties are ObjectProperties.hint and ObjectProperties.accessRight.
Multiple options can be separated by a pipe | character. For example:
hint=ab|
accessRight=ADD
The values for the ObjectProperties.hint option can be the prefix of the IP address for a network or the name of a network.
  • Example 1
    The following example will match networks that have the network ID starting with 2000::. For example, 2000::/64.
    String options = ObjectProperties.hint + “=2000::|”
  • Example 2
    The following example will match networks that have a name starting with “abc”. For example, “abc”, “abc123” or “abcdef”.
    String options = ObjectProperties.hint + “=abc|”
Note: Matching networks to a network ID Example 1 will take precedence over matching networks to a name Example 2.
The values for the ObjectProperties.accessRight option must be one of the constants listed in Access right values and Object types. For example:
String options = ObjectProperties.accessRight + "=" + AccessRightValues.AddAccess;
start

Location: query

Type: integer (int32)

Indicates where in the list of objects to start returning objects. The list begins at an index of 0.

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of IPv6 objects based on the input argument without their properties fields populated, or returns an empty array if containerId is invalid. If no access right option is specified, the View access level will be used by default.