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

Description

This function returns the number of server-wide notifications on an account.  

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Notifications/get_notifications_count

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get the number of notifications.
$get_notifications_count = $cpanel->uapi(
    'Notifications', 'get_notifications_count'
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get the number of notifications.
my $get_notifications_count = $cpliveapi->uapi(
    'Notifications', 'get_notifications_count'
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!--  Get the number of notifications. -->
[% data = execute( 'Notifications', 'get_notifications_count' ); %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Notifications get_notifications_count

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": 3
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
dataintegerThe number of server-wide notifications.A positive integer.3