Delete server from configuration cluster

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

Important:

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.

SecurityBasicAuth

Request

query Parameters

name

required

string

The hostname or IP address of a remote configuration cluster server.

Example: name=example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

object

get/delete_configclusterserver

Request samples

whmapi1 --output=jsonpretty \
  delete_configclusterserver \
  name='example.com'

Response samples

application/json

{"metadata": {"command": "delete_configclusterserver",
"name": "example.com",
"reason": "OK",
"result": 1,
"version": 1
}
}