Dashboard

getDashboardDetails

This function returns the Dashboard Object which will contain the data that appears on the main dashboard.

**returns**
Parameter name	Type	Description	Possible Values
statistics	Object	The Statistics Object from getStatistics.	total_new_alerts total_accounts total_backup_jobs total_backups total_disk_usage total_backup_jobs_running
alerts	List []	A list of the 3 most recent Alert Objects.	_id title message level created owner owner_name
queue	List []	A list of the most recent Queue Group Objects. (Max: 5)	_id owner owner_name created started ended type items items_completed finalize status log_id status_time execution_time actual_time log_file log_contents data
queue_summary	object	A compilation of different queue statuses.	pending processing completed failed
destinations	List []	A list of configured Destination Objects. (Max: 5)	_id name owner owner_name type count hidden readonly disabled disk_limit disk_usage update_date dr reindex running options
backup_jobs	List []	A list of configured Backup Job Objects. (Max: 5)	_id name destination destination_details type contains structure options state owner owner_name next_run last_run running disabled hidden time backup_quota manually_retain exclude_list encrypted schedules hooks filters

jetbackup5api -F getDashboardDetails

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getDashboardDetails

This function returns the Statistics Object containing information about the user.

**Returns**
Parameter name	Type	Description
total_new_alerts	Integer	Total number of new alerts in the past 24 hours.
total_accounts	Integer	Total number of accounts on the panel.
total_backup_jobs	Integer	Total number of Backup Jobs configured.
total_backups	Integer	Total number of Full Backups generated.
total_disk_usage	Integer	Total disk usage of all accounts (bytes).
total_backup_jobs_running	Integer	Total number of Backup Jobs currently running.

jetbackup5api -F getStatistics

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getStatistics

This function returns information on the current installation.

**Returns**
Parameter name	Type	Description
utcOffset	String	The server's UTC Time Offset.
debug	Boolean	Value to determine if Debug Mode is enabled.
bod_disabled	Boolean	Value to determine Backup on Demand is disabled.
development	Boolean	Value to determine if Development is enabled.
process	Boolean	Value to determine if the JetBackup 5 Daemon is running.
sync_accounts	Boolean	Value to determine if JetBackup is currently syncing accounts from Panel.
messages	String	Standard messages for license status. (Default: null)

jetbackup5api -F getInfo

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getInfo

This funtion returns the data for showcases that appear on first launch.

**Returns**
Parameter name	Type	Description	Possible Values
features	List []	List of Feature Objects	_id (String) feature (String) order (Integer) approved (Boolean)

Returns

Returns standard API Response data.

jetbackup5api -F listShowcase

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listShowcase