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

Description


This function lists the servers in the server's configuration cluster.

Warnings:

  • 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.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/list_configclusterservers&api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/list_configclusterservers?api.version=1
 Command Line
whmapi1 list_configclusterservers


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. 

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


Note:

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
server name
hash

A hash of database data.

Note:

The server's hostname is the hash name.

This hash includes the signature and user returns. 

signature

string

A truncated version of the server's remote access key.

The function returns this value in the server name hash.

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

user

string

The root-level username for the server.

The function returns this value in the server name hash.

A valid username.root