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.

Important: This function requires that the remote server node uses cPanel & WHM version 76 or later.

SecurityBasicAuth

Request

query Parameters

api_token required	string 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. Example: api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H
hostname required	string 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. Example: hostname=example.com
username required	string 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. Example: username=root
skip_tls_verification	integer Default: 0 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. Enum: 0 1 Example: skip_tls_verification=1

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/get_server_node_status

Request samples

whmapi1 --output=jsonpretty \
  get_server_node_status \
  api_token='23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H' \
  hostname='example.com' \
  username='root'

Response samples

application/json

{"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
}
}