Alerts

listAlerts

This function lists all Alert Objects.

To view available listing parameters, please visit List Parameters.

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

jetbackup5api -F listAlerts

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

This function prints the objects data given its Alert ID.

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

Returns the data for Alert Object.

jetbackup5api -F getAlert -D '_id=5f890a19e55cf262863522f2'

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

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'

level

Integer

The type of alert being sent.

1

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