---
title: "Add linked server node"
method: GET
path: "/link_server_node_with_api_token"
tags: ["Server Administration", "Server Nodes"]
---

# Add linked server node

`GET /link_server_node_with_api_token`

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](https://go.cpanel.net/whmlinkednodes)
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](https://go.cpanel.net/APITokensinWHM)
documentation.

## Query parameters

- `alias` string, required
- `api_token` string, required
- `hostname` string, hostname, required
- `username` string, username, required
- `skip_tls_verification` 1 | 0

## Response `200`

HTTP Request was successful.

- object
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)
