GET /v1/getLinkedEntities - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

Product name
BlueCat Integrity


Returns an array of entities containing the entities linked to a specified entity. The array is empty if there are no linked entities.
Note: This API method supports read-only API sessions. For more information on read-only API sessions and a list of API methods that support read-only API session, refer to Read-only Legacy v1 API sessions.


Name Description

Location: query

Type: integer (int32)

The maximum number of objects to return.

Location: query

Type: integer (int64)

The object ID of the entity for which to return linked entities.

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.

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.

Location: query

Type: string

The type of linked entities which need to be returned. This value must be one of the types listed in Object types.
  • While specifying a resource record as the entityId, if you want to find all the records CNAME, MX, or SRV records having links to this record, you can use RecordWithLink for the type parameter.
  • When specifying a MAC address as the entityId, this method returns the IPv4 address associated with the MAC address. When appropriate, leaseTimeand expiryTimeinformation also appears in the returned properties string.


Code Description

Type: Array of APIEntity

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