Child pages
  • WHM API 1 Functions - delete_configclusterserver
Skip to end of metadata
Go to start of metadata

 

Description

This function removes a server from a configuration cluster.

Important:

If you log in to a configuration cluster server that is not the master server, nothing will indicate that the server is part of a configuration cluster. You can only view and modify this information from the master server.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/delete_configclusterserver?api.version=1&name=example.com
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/delete_configclusterserver?api.version=1&name=example.com
 Command Line
whmapi1 delete_configclusterserver name=example.com


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 

 Output (JSON)
{
        "metadata":{
            "version":1,
            "name":"example.com",
            "reason":"OK",
            "result":1,
            "command":"delete_configclusterserver"
        }
}
 Output (XML)
<result>
  <metadata>
    <version>1</version>
    <name>example.com</name>
    <reason>OK</reason>
    <result>1</result>
    <command>delete_configclusterserver</command>
  </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
name
string

Required

The remote configuration cluster server's name.

A valid hostname or IP address.example.com

Returns

Note:

The function's return data appears in the metadata section of its output.

ReturnTypeDescriptionPossible valuesExample
name
string

The remote configuration cluster server's name.

A valid hostname or IP address.example.com