Update configuration cluster server credentials

This function updates the username or remote access key for a cluster server.

Important:

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 master server.
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.

SecurityBasicAuth

Request

query Parameters

name required	string The remote configuration cluster server's name or IP address. Example: name=example.com
key	string The new remote access key. If you do not specify a value, the function does not update the remote access key. Example: key=d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0
user	string The server's `root`-level account username. If you do not specify a value, the function does not update the username. Example: user=root

Responses

200

HTTP Request was successful.

Response Schema: application/json

object

get/update_configclusterserver

Request samples

whmapi1 --output=jsonpretty \
  update_configclusterserver \
  name='example.com'

Response samples

application/json

{"metadata": {"command": "update_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
}
}