GET /v1/searchResponsePolicyItems - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

ft:locale
en-US
Product name
BlueCat Integrity
Version
9.5.0

Description

Searches Response Policy items configured in local Response Policies or predefined BlueCat Security feed data. The search will return a list of all matching items in Address Manager across all configurations.
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.

Parameters

Name Description
count

Location: query

Type: integer (int32)

The total number of results to be returned. The possible value is a positive integer ranging from 1 to 1000.
keyword

Location: query

Type: string

The search string for which you wish to search.
  • ^ —matches the beginning of a string. For example: ^ex matches ex ample but not t ex t.
  • $ —matches the end of string. For example: ple$ matches exam ple but not ple ase.
  • * —matches zero or more characters within a string. For example: ex*t matches exit and ex cellen t.
properties

Location: query

Type: string

Reserved for future use. Use an empty string "" for now.
scope

Location: query

Type: string

The scope in which the search is to be performed. The possible values are:
  • RPItemSearchScope.LOCAL —to search policy items configured in local Response Policies.
  • RPItemSearchScope.FEED —to search policy items configured in predefined BlueCat Security Feed data.
  • RPItemSearchScope.ALL —to search policy items configured in both local Response Policies and predefined BlueCat Security Feed data.
start

Location: query

Type: integer (int32)

A starting number from where the search result will be returned. The possible value is a positive integer ranging from 0 to 999. For example, specifying 99 will return the search result from the 100th result to the maximum number that you specify with the count option.

Responses

Code Description
200

Type: Array of ResponsePolicySearchResult

Returns an array of ResponsePolicySearchResult objects. Each object contains information of one Response Policy item found either in local Response Policies or BlueCat Security feed data.