latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Configuration Clusters

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.
get/update_configclusterserver

Query parameters

namestring required
Example:example.com

The remote configuration cluster server's name or IP address.

keystring
Example:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0

The new remote access key. If you do not specify a value, the function does not update the remote access key.

userstring
Example:root

The server's root-level account username. If you do not specify a value, the function does not update the username.

Response

HTTP Request was successful.

Example response

{
  "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
  }
}