We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function calls the WHM API 1 send_test_pushbullet_note function with the system's specified Pushbullet™ accounts. You can specify Pushbullet accounts in the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup).

Examples  


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


Notes:

  • Unless otherwise noted, 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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
	"metadata": {
		"result": 1,
		"command": "verify_pushbullet_access",
		"version": 1,
		"reason": "OK"
	},
	"data": {
		"results": [{
			"access_token": "123456789012345678901234567890",
			"result": {
				"message_id": "J2SY",
				"payload": {
					"title": "Test message (ID: J2SY)",
					"dismissed": false,
					"sender_iden": "ABCDEFGHIJKL",
					"active": true,
					"receiver_iden": "ABCDEFGHIJKL",
					"iden": "ABCDEFGHIJKLABCDEFGHIJKL",
					"modified": 1584457760.74993,
					"sender_name": "Firstname Lastname",
					"direction": "self",
					"receiver_email_normalized": "user@example.com",
					"created": 1584457760.74319,
					"receiver_email": "user@example.com",
					"sender_email": "user@example.com",
					"type": "note",
					"sender_email_normalized": "user@example.com",
					"body": "This message confirms that “hostname.example.com” (192.168.0.20) can send a message to you via Pushbullet.\n\nThis message was sent on Tuesday, March 17, 2020 at 3:09:20 PM UTC."
				}
			}
		}]
	}
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>verify_pushbullet_access</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

This function returns the results of the WHM API 1 send_test_pushbullet_note function.

Note:

If the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup) contains multiple Pushbullet accounts, the function will return an array that contains the results for each account.