GET /v1/getAliasesByHint - BlueCat Address Manager - 9.2.0

Address Manager API Guide

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

Description

Returns an array of CNAMEs with linked record name.

Parameters

Name Description
count

Location: query

Type: integer (int32)

indicates the maximum of child objects that this method will return. The value must be less than or equal to 10.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
options

Location: query

Type: string

a string containing options. The supported options are hint and retrieveFields. Separate multiple options with a pipe character. For example:
hint=^abc|retrieveFields=false
If the hint option is not specified in the string, searching criteria will be based on the same as zone alias. The following wildcards are supported in the hint option.
  • ^ —matches the beginning of a string. For example: ^ex matches ex ample but not t ex t.
  • $ —matches the end of a string. For example: ple$ matches exam ple but not ple ase.
  • ^ $ —matches the exact characters between the two wildcards. For example: ^example$ only matches example.
  • ? —matches any one character. For example: ex?t matches ex i t.
  • * —matches one or more characters within a string. For example: ex*t matches exit and ex cellen t.
The default value for the retrieveFields option is set to false. If the option is set to true, user-defined field will be returned. If the options string does not contain retrieveFields, user-defined field will not be returned.
start

Location: query

Type: integer (int32)

indicates where in the list of objects to start returning objects. The list begins at an index of 0.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.

Responses

Code Description
200

Type: Array of APIEntity

Returns an array of Alias APIEntity objects.