Last modified October 31, 2024

manageSettingsSnapshots

This function allows you to create/modify the Settings Snapshots Object.
Parameters
Parameter name Type Description Possible Values Example
backup String Backup Job ID of the Backup Job Object selected for Backup on Demand.   backup=5f77b257272a784948143652
retain Integer Value to determine the retention of Backup on Demands for every account. (maximum 99) 1 - 99 retain=5
ttl Integer Value to determine the TTL of Backup on Demands for every account. Positive Integers ttl=3

Example Call JETAPI

jetbackup5api -F manageSettingsSnapshots -D "backup={$BACKUP_JOB_ID}&retain=5&ttl=3"
success: 1
message: Backup on Demand Settings Updated 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:
  backup: 65091af275e69fa2b808c0e2
  retain: 5
  ttl: 3
  rule_size: 5
  rule_inodes: 50000

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSettingsSnapshots&backup={$BACKUP_JOB_ID}&retain=5&ttl=3