DELETE /bhm/api/v1/servers - Adaptive Applications - BlueCat Gateway - 22.2

BlueCat Health Monitoring Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
22.2

Description

Remove a server from the BlueCat Health Monitoring service.

Parameters

Name Description
body Location: body

Type: application/json

{
  "authentication_method": string,
  "server_name": string,
  "server_ip": string,
  "username": string,
  "password": string,
  "password_root": string,
  "key_name": string
}
Authentication details for the server to be removed:
  • authentication_method: The method of server authentication. The possible values are password or private_key.
  • server_ip: The management IP address of the DNS/DHCP Server.
  • server_name: The name of the DNS/DHCP Server.
  • If password is selected as authentication method:
    • username: The SSH username used to access the DNS/DHCP Server.
    • password: The associated SSH password for the username.
  • If private key is selected as authentication method:
    • key_name: The name of the previously added SSH private key.
  • password_root (optional): The root password for the server, if the SSH user is not a root user.

Responses

Status Description
Successful

Code: 200

Body:
{
  "message": "Delete server {server_name} successfully"
}