CPcpanel
Server Administration
Server Nodes

Return linked server node status

This function returns the status of a linked remote server node. It returns the linked remote server's status with the WHM API 1 version and get_current_profile functions.

get/get_server_node_status

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

api_tokenstring required
Example:23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H

The required API token to make API calls to the remote server node.

Note:

The API token must have root-level access on the remote server node.

hostnamestring required
Example:example.com

The remote server node's hostname or IP address.

Note:

If you use an IP address, you must use the skip_tls_verification=1 parameter.

usernamestring required
Example:root

The username required to make API calls to the remote server node.

Note:

The username must have root-level access on the remote server node.

skip_tls_verification0 | 1
Example:1

Whether to skip SSL/TLS verification. The system performs this action when it queries the remote server node.

  • 1 - Skip SSL/TLS verification.
  • 0 - Do not skip SSL/TLS verification.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "enabled_services": [
      "apache_php_fpm"
    ],
    "remote_node_linkages": [
      {
        "alias": "MailNode",
        "enabled_services": [
          "apache_php_fpm",
          "cpanellogd",
          "cpdavd",
          "cpgreylistd",
          "cphulkd",
          "cpsrvd",
          "crond",
          "dnsadmin",
          "exim",
          "imap",
          "ipaliases",
          "lmtp",
          "mailman",
          "mysql",
          "named",
          "nscd",
          "pop",
          "queueprocd",
          "rsyslogd",
          "spamd",
          "sshd",
          "tailwatchd"
        ],
        "hostname": "mailnode.example.com",
        "last_check": 1583934071,
        "system_settings": {
          "Mail": {
            "globalspamassassin": "1"
          }
        },
        "tls_verified": 0,
        "username": "root",
        "version": "11.90.0.0",
        "worker_capabilities": {
          "Mail": {}
        }
      }
    ],
    "system_settings": {
      "Mail": {
        "globalspamassassin": 1
      }
    },
    "tls_verified": 1,
    "version": "11.90.0.0"
  },
  "metadata": {
    "command": "get_server_node_status",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.