POST /bsus/api/v1/servers/test-ssh - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

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

Description

Tests the SSH connections to the DNS/DHCP Server.

Parameters

Name Description
body Location: body

Type: application/json

The body of the DNS/DHCP Server to test. The JSON body is as follows:
{
  "bam_id": "string",
  "management_ip": "string",
  "authentication_method": "credentials/keys",
  "key_id": "string",
  "username": "string",
  "password": "string"
}
Parameters
  • bam_id—the ID of the Address Manager server that manages the DNS/DHCP Server.
  • management_ip—the IP address of the DNS/DHCP Server.
  • authentication_method—the authentication method used for the connection.
    • Use "credentials" to indicate an account password.
    • Use "keys" to indicate the use of an SSH key that was added to BSUS's list. See Configuring SSH Private Keys.
  • key_id—the ID name for the added key (if authentication_method is "keys").
  • username—the username that will be used to authenticate with the DNS/DHCP Server.
  • password—the password that will be used to authenticate with the DNS/DHCP Server.

Responses

Status Description
Successful

Code: 200

Body:
{
  "status": "success"
}
Error

Code: 400

Body:
{
  "status": "fail"
}

Code: 500

Body:
{
  "error": "string"
}

This can be caused when an unknown application error is encountered on the Server side. The API attempts to return additional details within the error parameter.