GET /bhm/api/v1/servers/search/ - Adaptive Applications - BlueCat Gateway - 22.2

BlueCat Health Monitoring Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
22.2

Description

Retrieves servers and associated information based on a given search criteria.

Parameters

Name Description
server Location: query

Type: string

The name of the server in Address Manager. The default is all.

ip Location: query

Type: string

The management IP address of the server. The default is all.

configuration Location: query

Type: string

The configuration that contains the server. This parameter is required.
sort Location: query

Type: string

The sorting direction. The default is asc.
order Location: query

Type: string

The value to sort by. The default is name.

start Location: query

Type: int

The starting position of results to display. The default is 0.
count Location: query

Type: int

The limit for results returned by the search. The default is 10.

Responses

Status Description
Successful

Code: 200

Body:
[
  {
    "configuration": "string",
    "fqdn": "string",
    "ipaddress": "string",
    "name": "string",
    "roles": array[string],
    "software_version": "string",
    "xha": {
      "ip_cluster": "string",
      "ip_xha_active": "string",
      "ip_xha_passive": "string",
      "is_xha": boolean,
      "node_name": "string"
    }
  },
  ...
]