Last modified October 31, 2024

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

Example Call JETAPI

jetbackup5api -F getDashboardDetails
success: 1 message: system: version: 5.3.3 version_panel: 5.3.3 tier: EDGE type: cPanel retry_ms: 0 disableui: dr: agreement_panel: agreement: licenseIssue: data: statistics: total_new_alerts: 4 total_accounts: 4 total_backup_jobs: 3 total_clone_jobs: 0 total_backups: 1304 total_account_backups: 0 total_disk_usage: 8093958144 total_backup_jobs_running: 0 total_clone_jobs_running: 0 alerts: 0: _id: 6509fa687812ab761e0b2f42 title: Restore for the account user completed successfully message: Restore process for the account user completed successfully in 11 Seconds level: 1 send_logs: 0: integration: Default Email Notification message: Successfully Sent created: 2023-09-19T19:45:44+00:00 status: 1 created: 2023-09-19T19:45:44+00:00 owner: 6503d48bfc45b1addf0a9636 owner_name: user queue: groups: 0: _id: 6509fa5d381ecbc5a80b2f0e owner: 6503d48bfc45b1addf0a9636 owner_name: user created: 2023-09-19T19:45:33+00:00 started: 2023-09-19T19:45:33+00:00 ended: 2023-09-19T19:45:44+00:00 type: 2 items: 1 items_completed: 1 finalize: status: 100 can_rerun: rerun_failed: log_id: 6509fa5d193c20350a0f7492 status_time: 2023-09-19T19:45:44+00:00 progress: _id: 6509fa5d381ecbc5a80b2f10 group_id: 6509fa5d381ecbc5a80b2f0e item_id: 6509fa5d381ecbc5a80b2f0f name: total: 1 completed: 0 subtotal: 1 subcompleted: 1 name_files: total_files: 0 completed_files: 0 percentage: 0 percentage_sub: 100 percentage_files: 0 execution_time: 11 actual_time: 11 log_file: /usr/local/jetapps/var/log/jetbackup5/queue/2_6509fa5d381ecbc5a80b2f0e.log log_contents: data: account: user priority: 100010 queue_summary: pending: 0 processing: 0 completed: 1 failed: 1 destinations: destinations: 0: _id: 6503d9d5a31fb181bf02f682 name: local owner: 6503d48bfc45b1addf0a9632 owner_name: root type: Localv2 job_type: 1 count: 0 hidden: readonly: disabled: disk_limit: 95 disk_usage: usage: 39626219520 free: 11674419200 total: 51300638720 threads: 10 update_date: 2023-09-19T17:56:12+00:00 dr: 1 reindex: running: options: path: /backup2 legacy: backup_jobs: jobs: 0: _id: 6503d9d5a31fb181bf02f684 name: JetBackup Config destination: 0: 6503d9d5a31fb181bf02f682 1: 6503eec8ebbf07708d06f1d2 destination_details: 0: _id: 6503d9d5a31fb181bf02f682 name: local owner: 6503d48bfc45b1addf0a9632 owner_name: root type: Localv2 job_type: 1 count: 0 hidden: readonly: disabled: disk_limit: 95 disk_usage: usage: 39626219520 free: 11674419200 total: 51300638720 threads: 10 update_date: 2023-09-19T17:56:12+00:00 dr: 1 reindex: running: options: path: /backup2 legacy:

Example Call HTTP

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