WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

getBackupJob

Description

This function returns a backup job by id.

Parameters

Parameter name Type Description Possible values Example
_id String Required
The ID of the backup job.		   5b59d203d5ac5e651d0af502

Returns

This API call returns backup job object.
To view the parameters returned, click on Backup Job Object

Example

jetapi backup -F getBackupJob -D '_id=5b59d203d5ac5e651d0af502'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=getBackupJob&_id=5b59d203d5ac5e651d0af502