GET /v1/getEntityByName - BlueCat Address Manager - 9.1.0

Address Manager API Guide

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

Description

Returns objects from the database referenced by their name field.

Parameters

Name Description
name

Location: query

Type: string

The name of the target object.
parentId

Location: query

Type: integer (int64)

The ID of the target object’s parent object.
type

Location: query

Type: string

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

Responses

Code Description
200

Type: APIEntity

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