GET /v1/getParent - BlueCat Address Manager - 9.4.0

Address Manager API Guide

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

Description

Returns the parent entity of a given entity.

Parameters

Name Description
entityId

Location: query

Type: integer (int64)

The entity ID of the child object that you would like to find the parent entity ID of.
includeHA

Location: query

Type: boolean

An optional boolean flag for REST calls that sets the level of detail when retrieving xHA pair server objects. Polling the xHA status of paired servers during a search can cause delays, or connection timeouts if a server is unreachable. When the parameter is set to true, the returned xHA server object will include details for the xHA status of the nodes. When set to false, the returned xHA server object will include only basic information without polling xHA status of the servers. The default value if omitted is true.

Responses

Code Description
200

Type: APIEntity

Returns the APIEntity for the parent entity with its properties fields populated.