GET /v1/getEntityById - 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 objects from the database referenced by their database ID and with its properties fields populated. For more information about the available options, refer to IPv4 objects in the Property Options Reference section.

Parameters

Name Description
id

Location: query

Type: integer (int64)

The object ID of the target object.
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 requested object from the database with its properties fields populated.