Add configuration cluster server

This function adds a server to a configuration cluster. The function's return data appears in the metadata section of its output.

We recommend that you run this function as a POST request with SSL enabled:

The length of the remote access key may cause problems if you run the function with the GET method (for example, a URL in your browser).
You risk security problems if you enter a remote access key through the GET method.

Important:

Run this function as a root-level user on the server that you wish to use as the parent server.
If you log in to a configuration cluster server that is not the parent server, nothing will indicate that the server is part of a configuration cluster. You can only view and modify this information from the parent server.

SecurityBasicAuth

Request

query Parameters

key required	string A truncated version of the server's remote access key. Example: key=d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0
name required	string The remote configuration cluster server's name. Example: name=example.com
user required	string The username for the server's `root`-level account. Example: user=root

Responses

200

HTTP Request was successful.

Response Schema: application/json

object

post/add_configclusterserver

Request samples

whmapi1 --output=jsonpretty \
  add_configclusterserver \
  name='example.com' \
  user='root' \
  key='d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0'

Response samples

application/json

{"metadata": {"command": "add_configclusterserver",
"name": "example.com",
"reason": "OK",
"result": 1,
"signature": "d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0",
"user": "root",
"version": 1
}
}