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.

SecurityBasicAuth

Request

query Parameters

alias required	string [ 1 .. 50 ] characters 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. Example: alias=example
api_token required	string 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. Example: api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H
hostname required	string <hostname> The remote server node's hostname. Note: This parameter does not accept an IP address. Example: hostname=host.example.com
username required	string <username> 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. Enum: 1 0 Example: skip_tls_verification=0

Responses

200

HTTP Request was successful.

Response Schema: application/json

object

get/link_server_node_with_api_token

Request samples

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

Response samples

application/json

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