Logs

listLogs

This function lists all Log Objects.

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.
Please utilize the skip parameter if you wish to list items more than 100 records

**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.		`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

getLog

This function prints the objects data given its Log ID.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Log ID.		`_id=5f890a19e55cf262863522f2`
content	Boolean	Flag to print contents of requested log	1/0	`content=1`

Example Call JETAPI

jetbackup5api -F getLog -D "_id={$LOG_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: 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

Example Call HTTP

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

deleteLog

This function allows you to delete the object given its Log ID.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Log ID		`_id=5f890a19e55cf262863522f2`

Example Call JETAPI

jetbackup5api -F deleteLog -D "_id={$LOG_ID}"

success: 1
message: Logs Deleted 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=deleteLog&_id={$LOG_ID}

listLogItems

This function lists all Log Item Objects.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
log_id	String	REQUIRED The Log ID you would like to list items from.		`log_id=5f890a19e55cf262863522f2`

**Returns**
Parameter name	Type	Description	Possible Values	Example
items	List []	List of all Log Item Objects.
total	Integer	Total number of Log Item Objects.

Example Call JETAPI

jetbackup5api -F listLogItems -D "log_id={$LOG_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:
  items:
        0:
          _id: 65091b55d49adbd1660f06e9
          owner: 6503eba4c6477f48c309376f
          owner_name: example
          created: 2023-09-19T03:53:57+00:00
          started: 2023-09-19T03:53:58+00:00
          ended: 2023-09-19T03:54:06+00:00
          execution_time: 8
          type: 1
          group_id: 65091b55d49adbd1660f06e8
          priority: 50
          status: 100
          message: Backup completed successfully
          progress_id: 65091b55d49adbd1660f06eb
          progress:
                _id: 65091b55d49adbd1660f06eb
                group_id: 65091b55d49adbd1660f06e8
                item_id: 65091b55d49adbd1660f06e9
                name:
                total: 11
                completed: 11
                subtotal: 0
                subcompleted: 0
                name_files: Local
                total_files: 0
                completed_files: 0
                percentage: 100
                percentage_sub: 0
                percentage_files: 0
          file: /usr/local/jetapps/var/log/jetbackup5/queue/1_65091b55d49adbd1660f06e8/65091b55d49adbd1660f06e9.log
          data:
                _id: 65091af275e69fa2b808c0e2
                manually: 1
                snapshot:
                account: example
                account_nickname: example
                destinations:
                0: 6508e8f1bd155427ab017ca2
        1:
          _id: 65091b55d49adbd1660f06ea
          owner: 65091b2a3f17831bb00f06e1
          owner_name: example2
          created: 2023-09-19T03:53:57+00:00
          started: 2023-09-19T03:53:58+00:00
          ended: 2023-09-19T03:54:06+00:00
          execution_time: 8
          type: 1
          group_id: 65091b55d49adbd1660f06e8
          priority: 50
          status: 100
          message: Backup completed successfully
          progress_id: 65091b55d49adbd1660f06ec
          progress:
                _id: 65091b55d49adbd1660f06ec
                group_id: 65091b55d49adbd1660f06e8
                item_id: 65091b55d49adbd1660f06ea
                name:
                total: 11
                completed: 11
                subtotal: 0
                subcompleted: 0
                name_files: Local
                total_files: 0
                completed_files: 0
                percentage: 100
                percentage_sub: 0
                percentage_files: 0
          file: /usr/local/jetapps/var/log/jetbackup5/queue/1_65091b55d49adbd1660f06e8/65091b55d49adbd1660f06ea.log
          data:
                _id: 65091af275e69fa2b808c0e2
                manually: 1
                snapshot:
                account: example2
                account_nickname: example2
                destinations:
                0: 6508e8f1bd155427ab017ca2
  total: 2

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listLogItems&log_id={$LOG_ID}

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

getLogItem

This function prints the objects data given its Log Item ID.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
log_id	String	REQUIRED The Log ID.		`log_id=5f890a19e55cf262863522f2`
_id	String	REQUIRED The Log Item ID.		`_id=607e460b7a5bf7162226855f`

The Log ID and Log Item ID can be found by running the listLogs/listLogItems commands respectively.

Example Call JETAPI

jetbackup5api -F getLogItem -D "log_id={$LOG_ID}&_id={$LOG_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: 65091b55d49adbd1660f06ea
  owner: 65091b2a3f17831bb00f06e1
  owner_name: example2
  created: 2023-09-19T03:53:57+00:00
  started: 2023-09-19T03:53:58+00:00
  ended: 2023-09-19T03:54:06+00:00
  execution_time: 8
  type: 1
  group_id: 65091b55d49adbd1660f06e8
  priority: 50
  status: 100
  message: Backup completed successfully
  progress_id: 65091b55d49adbd1660f06ec
  progress:
        _id: 65091b55d49adbd1660f06ec
        group_id: 65091b55d49adbd1660f06e8
        item_id: 65091b55d49adbd1660f06ea
        name:
        total: 11
        completed: 11
        subtotal: 0
        subcompleted: 0
        name_files: Local
        total_files: 0
        completed_files: 0
        percentage: 100
        percentage_sub: 0
        percentage_files: 0
  file: /usr/local/jetapps/var/log/jetbackup5/queue/1_65091b55d49adbd1660f06e8/65091b55d49adbd1660f06ea.log
  data:
        _id: 65091af275e69fa2b808c0e2
        manually: 1
        snapshot:
        account: example2
        account_nickname: example2
        destinations:
        0: 6508e8f1bd155427ab017ca2

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getLogItem&log_id={$LOG_ID}&_id={$LOG_ITEM_ID}

Parameter Dictionary

Log Object

Parameter name

Type

Description

Possible Values

Example

_id

String

The Log ID.

5f8a21545108792bb859b1a3

start_time

Date

The date and time the log was created.

'2021-04-07T14:17:02+00:00'

end_time

Date

The date and time the log was completed.

2021-04-07T14:17:02+00:00

execution_time

Integer

Total time (seconds) the process spent executing.

146 (secs)

actual_time

Integer

Total time (seconds) the process spent pending in the queue AND executing.

500 (secs)

info

list []

Additional information for the process that was executed. Backup Job ID, Account name, etc.

status

Integer

Status of the process after completion.

Completed	1
Failed	2
Aborted	3
Partially Complete	4
Never Finished	5
Processing	6

1 (Completed)

type

Integer

The type of log.

Backup	1
Download	2
Restore	3
System	4
Reindex	5
Backup on Demand	6

file

String

The corresponding path to the log file.

/usr/local/jetapps/var/log/jetbackup5/queue/1_607e54187a5bf71622268560.log

items

String

The corresponding path to the log items file.

/usr/local/jetapps/var/log/jetbackup5/queue/1_607e54187a5bf71622268560.items

Log Item Object

Type Name

Type

Description

Possible Values

Examples

_id

String

The Log Item ID.

607e54197a5bf71622268561

owner

String

The ID of the owner.

606dbe8b90f1b17d0569b834

owner_name

String

The name of owner matching the corresponding owner ID.

root

created

Date

The date and time the log item was created.

2021-04-20T04:10:01+00:00

started

Date

The date and time the log item began processing.

2021-04-20T04:10:01+00:00

ended

Date

The date and time the log item was completed.

2021-04-20T04:10:08+00:00

execution_time

Integer

Total amount of time (seconds) the Log Item spent processing.

7 (secs)

type

Integer

The type of log.

Backup	1
Download	2
Restore	3
System	4
Reindex	5
Backup on Demand	6

Status

Integer

Status of the process after completion.

Pending	1
Processing	2
Completed	100
Partially Complete	101
Failed	102
Aborted	103
Never Finished	104

JETAPI Documentation

On This Page:

Logs

listLogs

getLog

deleteLog

listLogItems

getLogItem

Parameter Dictionary

Log Object

Log Item Object

On This Page: