GET /v1/customSearch - BlueCat Address Manager - 9.2.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.2.0

Description

Search for an array of entities by specifying object properties.

Parameters

Name Description
count

Location: query

Type: integer (int32)

The maximum number of objects to return. The value must be a positive value between 1 and 1000.
filters

Location: query

Type: array

The list of properties on which the search will be based. The valid format is Field name=value. Refer to Reference: Supported search object types and fields for details.
Note: The field name is case-sensitive.
In addition to the fields that are specified in the table, any user-defined fields will also be supported.
Note: The valid format for the Date type user-defined field value is DD-MMM-YYYY. You can also use partial formatting. For example, 10-Jan-2016, 10-Jan, Jan-2016 or 2016.
options

Location: query

Type: array

The list of search options specifying the search behavior. Reserved for future use.
start

Location: query

Type: integer (int32)

Indicates where in the list of returned objects to start returning objects. The value must be a positive value.
type

Location: query

Type: string

The object type that you wish to search. This must be one for the following object types:
  • IP4Block
  • IP4Network
  • IP4Addr
  • GenericRecord
  • HostRecord
  • Any other objects with user-defined fields

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of APIEntities matching the specified object properties or returns an empty array. The APIEntity will at least contain Object Type, Object ID, Object Name, and Object Properties.