Return all configuration cluster servers

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

Warning:

  • WHM's Remote Access Key feature is deprecated. We strongly recommend that you use API tokens instead.

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

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
object

Configuration cluster signatures and users for each server.

object
get/list_configclusterservers
Request samples
whmapi1 --output=jsonpretty \
  list_configclusterservers
Response samples
application/json
{
  • "data": {
    • "example1.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": {
    • "command": "list_configclusterservers",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}