Last modified November 7, 2024

getBackupItem

This function will return the specified Backup Item Data.
Parameters
Parameter name Type Description Possible Values Example
_id String REQUIRED The Backup Item ID. Use the getBackupItems calls above to see the Backup Item ID. _id=60b164083c2bb904123c2aa6
Returns
Parameter name Type Description Data
data Backup Object The Backup Object corresponding to the given Backup Item ID. See Backup Object below to see all available data.

Example Call JETAPI

jetbackup5api -F getBackupItem -D "_id={$BACKUP_ITEM_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: 6503f05fedc7b9f4520a9679
parent_id: 6503ef22edc7b9f4520a9643
account_id: 6503d48bfc45b1addf0a9636
destination: 6503eec8ebbf07708d06f1d2
destination_name: s3
name:
created: 2023-09-15T05:44:02+00:00
path:
backup_type: 1
backup_contains: 256
account: user
account_data:
        _id: 6503d48bfc45b1addf0a9636
        username: user
        owner: root
        owner_id: 6503d48bfc45b1addf0a9632
        package: default
        suspended:
        reseller:
        root:
size: 186
params:
backup_structure: 1
notes:
location:
safety:
deleted:
lock:
lock_ttl:
damaged:
disabled:
schedules:
        0: 8
hidden:
encrypted:
encryption_id:
encryption_key_required:
encryption_key_exists: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getBackupItem&_id={$BACKUP_ITEM_ID}