GET /bhm/api/v1/servers - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Health Monitoring Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.1

Description

Retrieves a list of all servers.

Parameters

Name Description
sort (optional) Location: query

Type: string

The method by which servers are sorted. The value must be asc for ascending order or desc for descending order. The default value is asc.

count (optional) Location: query

Type: integer

The number of servers to return. The default value is 10.

start (optional) Location: query

Type: integer

The starting position of servers returned. The default value is 0.

order (optional) Location: query

Type: integer

Defines the order of the server. The possible values are name and virtual_memory. The default value is name.

Responses

Status Description
Successful

Code: 200

Body:
For each server:

{
    "cpu_usage": float,
    "ipaddress": "string",
    "name": "string",
    "server_id": int,
    "software_version": "string",
    "uptime": int,
    "virtual_memory": {
        "available": int,
        "used": int
    },
    "xha": {
        "ip_cluster": "string",
        "ip_xha_active": "string",
        "ip_xha_passive": "string",
        "is_xha": bool,
        "node_name": "string",
    }
}