---
title: "Add configuration cluster server"
method: POST
path: "/add_configclusterserver"
tags: ["Server Administration", "Configuration Clusters"]
---

# Add configuration cluster server

`POST /add_configclusterserver`

This function adds a server to a configuration cluster. The function's return data appears in
the `metadata` section of its output.

We recommend that you run this function as a `POST` request with SSL enabled:

* The length of the remote access key may cause problems if you run the function with the `GET`
method (for example, a URL in your browser).
* You risk security problems if you enter a remote access key through the `GET` method.

**Important:**

* Run this function as a `root`-level user on the server that you wish to use as the parent server.
* If you log in to a configuration cluster server that is **not** the parent server, **nothing**
will indicate that the server is part of a configuration cluster. You can **only** view and modify
this information from the parent server.

## Query parameters

- `key` string, required
- `name` string, required
- `user` string, required

## Response `200`

HTTP Request was successful.

- object
  - `metadata` object
    - `command` string — The method name called.
    - `name` string — The remote configuration cluster server's name.
    - `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.
    - `signature` string — A truncated version of the server's remote access key.
    - `user` string — The username for the server's `root`-level account.
    - `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)