Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function removes cPanel Support's IP addresses from your server's firewall whitelist. This function is firewall-specific and does not change the cPhulk whitelist.

Note:

$body

Examples


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

Unable to render {include} The included page could not be found.

 Output (JSON)
{
	"metadata": {
		"result": 1,
		"reason": "OK",
		"command": "ticket_whitelist_unsetup",
		"version": 1
	},
	"data": {
		"chain_status": "INACTIVE"
	}
}
 Output (XML)
<result>
	<metadata>
		<result>1</result>
		<reason>OK</reason>
		<command>ticket_whitelist_unsetup</command>
		<version>1</version>
	</metadata>
	<data>
		<chain_status>INACTIVE</chain_status>
	</data>
</result>


Note:

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
chain_statusstringA message that indicates whether the whitelist removal succeeded.
  • INACTIVE — Success.
  • ERR_UNSETUP — An error occurred.

INACTIVE