Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - ticket_whitelist_setup - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - ticket_whitelist_setup
Skip to end of metadata
Go to start of metadata

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.

Note:

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


Examples


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

Warning:

You cannot use this method to call the function.

 Output (JSON)
{
	"metadata": {
		"version": 1,
		"result": 1,
		"command": "ticket_whitelist_setup",
		"reason": "OK"
	},
	"data": {
		"chain_status": "ACTIVE"
	}
}
 Output (XML)
<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>	


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 setup succeeded.
  • ACTIVE — A successful setup.
  • ERR_SETUP — An error occurred.

ACTIVE