This function links your server to a remote server node. The server uses an API token to communicate with the remote server node.
- This function only runs on a Standard Node profile server.
- You cannot link to a remote server node that uses cPanel & WHM version 76 and earlier. The remote server node must use a version that is the same as or greater than your server version.
- This function requires the use of an API token. For more information, read our Guide to API Authentication - API Tokens in WHM documentation.
- In cPanel & WHM version 82, this function only links servers that are capable of mail services. If a server does not have mail service capability, you cannot use this function.
A unique name that refers to the remote server node.
A valid name.
The alias may only contain alphanumeric characters, dashes (
The API token required to make API calls to the remote server node.
The API token must have
A valid API token.
The remote server node's hostname.
A valid hostname.
This parameter does not accept an IP address.
The username required to make API calls to the remote server node.
A valid username.
The username must have
Whether to skip SSL/TLS verification. The system performs this action when it queries the remote server node.
This value defaults to
This function only returns metadata.