Update linked server node settings

This function updates a linked remote cPanel server node.

Important:

You cannot link to a remote cPanel server node that uses cPanel & WHM version 76 and earlier. The remote cPanel 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 cPanel servers that are capable of mail services. If a server does not have mail service capability, you cannot use this function.

SecurityBasicAuth

Request

alias required	string The name of a linked remote cPanel server node. Example: alias=example
api_token	string The API token required to make API calls to the remote cPanel server node. This value defaults to the existing API token. Note: The API token must have `root`-level access on the remote cPanel server node. Example: api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H
hostname	string A new remote cPanel server node's hostname. The system will update your remote cPanel server node's hostname to this value. This value defaults to the existing hostname. Note: This parameter does not accept an IP address. Example: hostname=example.com
skip_tls_verification	integer Default: 1 Whether to skip SSL/TLS verification. The system performs this action when it queries the remote cPanel server node. Note: If the remote cPanel server is SSL/TLS verified, you cannot skip verification. Enum: 0 1 Example: skip_tls_verification=0
username	string The username required to make API calls to the remote cPanel server node. This value defaults to the existing username. Note: The username must have `root`-level access on the remote cPanel server node. Example: username=root

Responses

200

HTTP Request was successful.

object

get/update_linked_server_node

Request samples

whmapi1 --output=jsonpretty \
  update_linked_server_node \
  alias='example'

Response samples

application/json

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