latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration

Server Nodes

Add linked server node

This function links your server to a remote server node. The server uses an API token to communicate with the remote server node.

Important:

This function only runs on a Standard Node profile server.
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.

get/link_server_node_with_api_token

aliasstring required

Example:example

A unique name that refers to the remote server node.

Note:

The alias may only contain alphanumeric characters, dashes (-), and underscores (_). It also has a maximum length of 50 characters.

api_tokenstring required

Example:23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H

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

Note:

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

hostnamestring hostname required

Example:host.example.com

The remote server node's hostname.

Note:

This parameter does not accept an IP address.

usernamestring username 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_verification1 | 0

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

HTTP Request was successful.

{
  "metadata": {
    "command": "link_server_node_with_api_token",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}