Restore Conditions

manageRestoreCondition

This function allows you to create/modify the Restore Condition Object.

Parameters

Parameter name	Type	Description	Possible Values	Example
action	String	REQUIRED on both create/modify. The action you want to perform	modify create	`action=create`
condition	String	REQUIRED on both create/modify. The string of text for the user to agree.
_id	String	REQUIRED on action modify. Restore Condition ID is used for when you want to modify any of the Restore Condition Object Fields.		`type_data=5f864533cde674169f42ffe2`

Example Call JETAPI

jetbackup5api -F manageRestoreCondition -D "action=create&condition=Are you sure?"

jetbackup5api -F manageRestoreCondition -D "action=modify&_id={$RESTORE_CONDITION_ID}&condition=Are you sure?"

success: 1
message: Restore Condition Created/Updated 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:
  _id: 650a09c88a71e8105406e6c2
  condition: Are you sure?
  disabled:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageRestoreCondition&action=create&condition=Are you sure?

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageRestoreCondition&action=modify&_id={$RESTORE_CONDITION_ID}&condition=Are you sure?

listRestoreConditions

This function lists all Restore Condition Objects.

More Info

Parameters

Function call does not require parameters. View common sorting actions you can use to filter results.

Example Call JETAPI

jetbackup5api -F listRestoreConditions

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:
  conditions:
        0:
          _id: 650a09c88a71e8105406e6c2
          condition: Are you sure?
          disabled:
        1:
          _id: 650a0a889b70f2a5ac08c4b2
          condition: example
          disabled:
  total: 2

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listRestoreConditions

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

getRestoreCondition

This function prints the objects data given its Restore Condition Object ID.

More Info

Parameters

Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED Restore Condition ID of the Restore Condition Object you are trying to fetch.		`_id=5f864533cde674169f42ffe2`

Example Call JETAPI

jetbackup5api -F getRestoreCondition -D "_id={$RESTORE_CONDITION_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: 650a0a889b70f2a5ac08c4b2
  condition: example
  disabled:

Example Call HTTP

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

deleteRestoreConditions

This function allows you to delete the object given its Restore Condition Objects ID.

More Info

Parameters

Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED Restore Condition ID of the Restore Condition Object you are trying to delete.		`_id=5f864533cde674169f42ffe2`

Example Call JETAPI

jetbackup5api -F deleteRestoreCondition -D "_id={$RESTORE_CONDITION_ID}"

success: 1
message: Restore Condition 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=deleteRestoreCondition&_id={$RESTORE_CONDITION_ID}

Parameter Dictionary

Restore Condition Object

Parameter name	Type	Description	Possible Values	Example
_id	String	The Restore Condition ID.		5b28f9f4d5ac5e5ed5049f82
condition	String			'Are you sure?'
disabled	Boolean	Boolean value to determine if the Restore Condition is disabled.	1: True 0: False	disabled: 0

JETAPI Documentation

On This Page:

Restore Conditions

manageRestoreCondition

listRestoreConditions

getRestoreCondition

deleteRestoreConditions

Parameter Dictionary

Restore Condition Object

On This Page: