Description

This function adds cPanel Support's IP addresses to your server's firewall whitelist.

 This function is firewall-specific and does not change the cPhulk whitelist.

This function logs error messages to the /usr/local/cpanel/logs/error_log file.


Examples




https://hostname.example.com:2087/cpsess##########/json-api/ticket_whitelist_setup?api.version=1




https://hostname.example.com:2087/cpsess##########/xml-api/ticket_whitelist_setup?api.version=1




whmapi1 ticket_whitelist_setup



{
	"metadata": {
		"version": 1,
		"result": 1,
		"command": "ticket_whitelist_setup",
		"reason": "OK"
	},
	"data": {
		"chain_status": "ACTIVE"
	}
}




<result>
	<metadata>
		<version>1</version>
		<result>1</result>
		<command>ticket_whitelist_setup</command>
		<reason>OK</reason>
	</metadata>
	<data>
		<chain_status>ACTIVE</chain_status>
	</data>
</result>	



   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
chain_statusstringA message that indicates whether the whitelist setup succeeded.
  • ACTIVE — A successful setup.
  • ERR_SETUP — An error occurred.

ACTIVE