Alerts

listAlerts

This function lists all Alert Objects.

Returns

Parameter name	Type	Description	Possible Values	Example
schedules	List []	List of all Alert Objects.
total	Integer	Total number of Alert Objects.

Example Call JETAPI

jetbackup5api -F listAlerts

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:
alerts:
        0:
        _id: 6508e8f223774d67a60f06db
        title: Reindex for the destination Local started
        message: Reindex process for the destination Local started
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:18:58+00:00
                status: 1
        created: 2023-09-19T00:18:58+00:00
        owner: 65075382d49adbd1660f06d2
        owner_name: root
        1:
        _id: 6508e8f223774d67a60f06dc
        title: Reindex for the destination Local completed successfully
        message: Reindex process for the destination Local successfully in less then a second
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:18:58+00:00
                status: 1
        created: 2023-09-19T00:18:58+00:00
        owner: 65075382d49adbd1660f06d2
        owner_name: root
        2:
        _id: 6508e9ae20b47525b50f06de
        title: Download for the account example started
        message: Download process for the account example started
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:22:06+00:00
                status: 1
        created: 2023-09-19T00:22:06+00:00
        owner: 6503eba4c6477f48c309376f
        owner_name: example
        3:
        _id: 6508e9be20b47525b50f0782
        title: Download for the account example completed successfully
        message: Download process for the account example completed successfully in 16 Seconds
        level: 1
        send_logs:
                0:
                integration: Default Email Notification
                message: Successfully Sent
                created: 2023-09-19T00:22:22+00:00
                status: 1
        created: 2023-09-19T00:22:22+00:00
        owner: 6503eba4c6477f48c309376f
        owner_name: example
total: 4

Example Call HTTP

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

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

getAlert

This function prints the objects data given its Alert ID.

More Info

**Returns**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Alert ID		`_id=5f890a19e55cf262863522f2`

Example Call JETAPI

jetbackup5api -F getAlert -D "_id={$ALERT_ID}"

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:
  _id: 6508e8f223774d67a60f06db
  title: Reindex for the destination Local started
  message: Reindex process for the destination Local started
  level: 1
  send_logs:
        0:
          integration: Default Email Notification
          message: Successfully Sent
          created: 2023-09-19T00:18:58+00:00
          status: 1
  created: 2023-09-19T00:18:58+00:00
  owner: 65075382d49adbd1660f06d2
  owner_name: root

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getAlert&_id=5f890a19e55cf262863522f2

clearAlerts

This function deletes all Alert Objects.

More Info

Example Call JETAPI

jetbackup5api -F clearAlerts

success: 1
message: Alerts cleared successfully
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:

Example Call HTTP

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

Parameter Dictionary

Alert Object

Parameter name

Type

Description

Possible Values

Example

title

String

The unique title for the alert.

'Backup job "Local" completed successfully'

message

String

The message that is sent for the alert.

'The backup job "Local" (#607458c5b743c715d0596752) completed successfully'

find[level]

Integer

The type of alert being sent.

Information	1
Warning	2
Critical	4

created

Date

The corresponding date/time the alert was sent.

2021-04-19T17:17:21+00:00

owner

String

The owner id for the owner of the alert.

6079ab6b49bdec64d20a3833

owner_name

String

The name of the owner matching the owner id.

root

JETAPI Documentation

On This Page:

Alerts

listAlerts

getAlert

clearAlerts

Parameter Dictionary

Alert Object

On This Page: