Last modified October 31, 2024

listLogs

This function lists all Log Objects.
Returns
Parameter name Type Description Possible Values Example
logs List [] List of all Log Objects.    
sort List[] The value you want to sort by.
  • 1 : ascending order
  • -1 : descending order
  • sort[start_time]=1
  • sort[end_time]=-1
  • sort[type]=1
  • sort[status]=-1
find List[] Find specific objects you want to filter.
  • Type
  • Status
  • info.Type
  • info.Backup Job
  • info.Destination
  • info.ID
  • find[Type]=1
  • find[Status]=2
  • find[info.Type]=Integrity Check / JB Config
  • find[info.Backup Job]={$BACKUP_JOB_NAME}
  • find[info.Destination]={$DESTINATION_NAME}
  • find[info.ID]={$BACKUP_JOB_ID}
skip Integer Skip the specified number of records returned.   skip=100
total Integer Total number of Log Objects.    

Example Call JETAPI

jetbackup5api -F listLogs -D "find[type]=1&skip=100&find[info.ID]={$BACKUP_JOB_ID}&sort[start_time]=1"
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:
  logs:
        0:
          _id: 6508e8f1bd155427ab017ca5
          start_time: 2023-09-19T00:18:57+00:00
          end_time: 2023-09-19T00:18:58+00:00
          execution_time: 1
          actual_time: 0
          info:
                Destination: Local
          status: 1
          type: 5
          file: /usr/local/jetapps/var/log/jetbackup5/queue/8_6508e8f1d49adbd1660f06d6.log
          items: /usr/local/jetapps/var/log/jetbackup5/queue/8_6508e8f1d49adbd1660f06d6.items
        1:
          _id: 6508e9aee2238a334103e472
          start_time: 2023-09-19T00:22:06+00:00
          end_time: 2023-09-19T00:22:22+00:00
          execution_time: 16
          actual_time: 16
          info:
                Account: example
                Priority: 50
          status: 1
          type: 2
          file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9.log
          items: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508e9aed49adbd1660f06d9.items
        2:
          _id: 6508f21e2f624c95fe0f1c72
          start_time: 2023-09-19T00:58:06+00:00
          end_time: 2023-09-19T00:58:22+00:00
          execution_time: 16
          actual_time: 16
          info:
                Account: example
                Priority: 50
          status: 2
          type: 2
          file: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508f21ed49adbd1660f06dc.log
          items: /usr/local/jetapps/var/log/jetbackup5/queue/4_6508f21ed49adbd1660f06dc.items
  total: 3

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listLogs&find[type]=1&find[info.ID]={$BACKUP_JOB_ID}&sort[start_time]=1