GET /v1/getEntitiesByName - 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 an array of entities that match the specified parent, name, and object type.

Parameters

Name Description
count

Location: query

Type: integer (int32)

The maximum number of objects to return. The default value is 10.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
name

Location: query

Type: string

The name of the entity.
parentId

Location: query

Type: integer (int64)

The object ID of the parent object of the entities to be returned.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
start

Location: query

Type: integer (int32)

Indicates where in the list of returned objects to start returning objects. The list begins at an index of 0.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
type

Location: query

Type: string

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

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of entities. The array is empty if there are no matching entities.