Last modified November 7, 2024

deleteAccountSnapshots

This function allows you to delete all snapshots from the specified user.
Parameters
Parameter name Type Description Example
approve Boolean Gives permission for the API command to delete snapshots approve=true
user String REQUIRED: ID of the user to delete their snapshots. If no other parameters are set, then all the user's snapshots are removed. user=6503d48bfc45b1addf0a9635
range_start (v5.3.10+) String - Format: 20yy-mm-ddThh:mm Removes snapshots generated on the set date/time and after range_start=2024-01-01T13:00
range_end (v5.3.10+) String - Format: 20yy-mm-ddThh:mm Removes snapshots generated on the set date/time and before range_end=2024-01-01T13:00
job (v5.3.12+) String Removes snapshots generated by the specified backup job job=663161b82b562fb74905b922
destination (v5.3.12+) String Removes snapshots generated on the specified destination destination=664a4a343068fb2dd6053582

Doesn’t return any data.

Example Call JETAPI

jetbackup5api -F deleteAccountSnapshots -D "user={$ACCOUNT_ID}&range_start=2024-01-01T13:00&range_end=2024-01-20T18:00&destination={$DESTINAION_ID}&job={$BACKUP_JOB_ID}&approve=true"
success: 1
message: User snapshots marked for delete 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=deleteAccountSnapshots&_id={$ACCOUNT_ID}&range_start=2024-01-01T13:00&range_end=2024-01-20T18:00&destination={$DESTINAION_ID}&job={$BACKUP_JOB_ID}&aprrove=yes}