GET /v1/searchByCategory - 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 an array of entities by searching for keywords associated with objects of a specified object category.
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 API sessions.

Parameters

Name Description
category

Location: query

Type: string

The entity category to be searched. This must be one of the entity categories listed in Entity categories.
count

Location: query

Type: integer (int32)

The maximum number of objects to return. The default value is 10.
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.
keyword

Location: query

Type: string

The search keyword string.
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.

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of entities matching the keyword text and the category type, or returns an empty array.