---
title: "Return linked remote server node settings"
method: GET
path: "/get_linked_server_node"
tags: ["Server Administration", "Server Nodes"]
---

# Return linked remote server node settings

`GET /get_linked_server_node`

This function returns details about a linked remote server node.

## Query parameters

- `alias` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `enabled_services` string[] — The services enabled on the linked remote server node.
    - `hostname` string, domain — The remote server node's hostname.
    - `last_check` integer — The last time that the server queried the current status of the remote server node.
    - `system_settings` unknown
    - `tls_verified` 0 | 1 — Whether the remote server node has a valid SSL certificate. * `1` - The remote server node has a valid SSL certificate. * `0` - The remote server node does not have a valid SSL certificate.
    - `username` string, username — The username required to make API calls to the linked remote server node.
    - `version` string — The version of cPanel & WHM installed on the remote server node.
    - `worker_capabilities` object — A group of services required for a remote server node to perform a specific task. The key is a role name and the value is an object with required options for the role.
  - `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` 0 | 1 — * `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)
