Child pages
  • WHM API 1 Functions - update_configclusterserver
Skip to end of metadata
Go to start of metadata

Description

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

Important:

  • We deprecated WHM's Remote Access Key feature in cPanel & WHM version 64. We strongly recommend that you use API tokens instead.
  • If you log in to a configuration cluster server that is not the master 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.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/update_configclusterserver?api.version=1&name=example.com&user=root&key=d0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/update_configclusterserver?api.version=1&name=example.com&user=root&key=d0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0
 Command Line
whmapi1 update_configclusterserver name=example.com user=root key=d0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0%3Ad0


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "metadata": {
    "signature": "d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0",
    "version": 1,
    "user": "root",
    "name": "example.com",
    "reason": "OK",
    "result": 1,
    "command": "update_configclusterserver"
  }
}
 Output (XML)
<result>
    <metadata>
        <signature>d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0</signature>
        <version>1</version>
        <name>example.com</name>
        <user>root</user>
        <reason>OK</reason>
        <result>1</result>
        <command>update_configclusterserver</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
name
string

Required

The remote configuration cluster server's name.

A valid hostname or IP address.example.com
userstring 

The server's root-level account username.

If you do not specify a value, the function does not update the username.

A valid username.root
keystring

The new remote access key.

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

A valid string.
 Click to view...
d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0

 

Returns 

Note:

The function's return data appears in the metadata section of its output.

ReturnTypeDescriptionPossible valuesExample
signaturestringThe new remote access key.A valid string.
 Click to view...
d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0
name
string

The remote configuration cluster server's name.

A valid hostname or IP address.example.com
userstring The server's root-level account username.A valid username.root