POST /bhm/api/v1/server/install - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Health Monitoring Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
22.1

Description

Add a BlueCat DNS/DHCP Server to the system.

Parameters

Name Description
body Location: body

Type: form-data

Information about the DNS/DHCP Server including the following:
  • 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.
  • receiver_ip: The IP address of the HTTP/S Receiver.
  • 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.
Example:
form-data (key/value)

authentication_method: password
server_ip: 192.168.1.30
receiver_ip: 192.168.1.1
username: root
password: rootpass

Responses

Status Description
Successful

Code: 200

Body:
{
    "message": "Added successfully"
}