Last modified October 31, 2024

manageNotificationIntegration

This function allows you to create/modify the Notification Integration Object.
parameters
Parameter name Type Description Possible Values Example
action String REQUIRED Sets the flag to either create or modify your Notification Integration.
  • create
  • modify
 action=create
_id String REQUIRED on action modify. The Notification Integration ID. N/A _id=648a03def62f62645905c2b2
type String The type of Notification Integration you will like to activate. Run listNotificationIntegrationTypes for a list of all available types. type=Email
frequency List [] Set the frequency of each Alert Level that you will like to receive.
Parameter (Alert Level) Possible Values
frequency[1] (Information)
  • 1 : Real Time
  • 2 : Once a Day
frequency[2] (Warning)
  • 1 : Real Time
  • 2 : Once a Day
frequency[4] (Critical)
  • 1 : Real Time
  • 2 : Once a Day
frequency[1]=1
name String REQUIRED on action create. The name given to the Notification Integration for internal use.   name=Admin Email
options List [] Options are additional fields that can be set based on the Notification Integration Type. Please check each Notification Type Object for the fields you can configure. options[recipients][email protected]

Example Call JETAPI

jetbackup5api -F manageNotificationIntegration -D "action=create&name=example&type=Email&frequency[1]=2&frequency[2]=1&frequency[4]=1&options[recipients][email protected]"

jetbackup5api -F manageNotificationIntegration -D "action=modify&_id={$NOTIFICATION_INTEGRATION_ID}&name=example&type=Email&frequency[1]=2&frequency[2]=1&frequency[4]=1&options[recipients][email protected]"
success: 1
message: Notification Integration Created 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:
  _id: 6509fbecaa590ab6b3060b32
  name: example
  owner: 65075382d49adbd1660f06d2
  owner_name: root
  type: Email
  frequency:
        1: 2
        2: 1
        4: 1
  disabled:
  options:
        recipients:
          0: [email protected]

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageNotificationIntegration&action=create&name=example&type=Email&frequency[1]=2&frequency[2]=1&frequency[4]=1&options[recipients]=[email protected]

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageNotificationIntegration&action=modify&_id={$NOTIFICATION_INTEGRATION_ID}&name=example&type=Email&frequency[1]=2&frequency[2]=1&frequency[4]=1&options[recipients]=[email protected]