Sign in
latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Server Nodes

Update linked server node settings

This function updates a linked remote cPanel server node.

Important:

This function requires the use of an API token. For more information, read our Guide to API Authentication - API Tokens in WHM documentation.

get/update_linked_server_node

Query parameters

aliasstring required
Example:example

The name of a linked remote cPanel server node.

api_tokenstring
Example:23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H

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.

hostnamestring
Example:example.com

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.

skip_tls_verification0 | 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.

usernamestring
Example:root

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.

Response

HTTP Request was successful.

Example response

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