Child pages
  • WHM API 1 Functions - update_configclusterserver

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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


Warning
titleImportant:
  • Include Page
    LIB:_RemoteAccessKeyDeprecated
    LIB:_RemoteAccessKeyDeprecated
  • 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.
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
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



Expand
titleXML API


Code Block
languagexml
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



Expand
titleCommand Line


Code Block
languagebash
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

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "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"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<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>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

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.


Expand
titleClick to view...
d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0


 

Returns 

Note
titleNote:

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


ReturnTypeDescriptionPossible valuesExample
signaturestringThe new remote access key.A valid string.


Expand
titleClick 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