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

Description 

This function checks whether the server's firewall whitelist correlates with the granted support tickets. You can view granted support tickets in WHM's Grant cPanel Support Access interface ( WHM >> Home >> Support >> Grant cPanel Support Access ).

Examples


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

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

 Output (JSON)
{
	"data": {
		"problem": "NO",
		"chain_status": "ACTIVE"
	},
	"metadata": {
		"reason": "OK",
		"result": 1,
		"version": 1,
		"command": "ticket_whitelist_check"
	}
}
 Output (XML)
<result>
	<data>
		<problem>NO</problem>
		<chain_status>ACTIVE</chain_status>
	</data>
	<metadata>
		<reason>OK</reason>
		<result>1</result>
		<version>1</version>
		<command>ticket_whitelist_check</command>
	</metadata>
</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_statusstringThe status of the server's firewall whitelist.
  • ACTIVE — The whitelist is active.
  • INACTIVE — The whitelist is inactive.
ACTIVE

problem

stringA message that indicates whether a problem exists with the current status.
  • NO — The firewall does not require changes.
  • NEED_SETUP — You have granted cPanel Support access, but the system's firewall whitelist does not contain support's IP addresses.
  • NEED_UNSETUP — The system detected that no cPanel Support access grants exist, but the system's firewall whitelist contains support's IP addresses.
NO