Last modified November 29, 2024

runIntegrityCheck

This function allows you to execute an Integrity Check manually on demand.
Parameters
Parameter name Type Description Possible Values Example
_id String The destination Object ID. For a list of Destination IDs, please use listDestinations _id=6169fde7916d0366563db4b2
user_id String Optional The account user ID. Runs the Integrity Check only on the specified account. This option does NOT require the user_name. For a list of user IDs, please use listAccounts user_id=9879fde8573d0125563dc4b2
user_name String Optional The username of the account. Will run the Integrity Check on ALL accounts with the username (including orphan accounts). This option should NOT be included if using the user_id. For a list of account usernames, please use listAccounts user_name=exampleUser
rebuild Boolean Optional Force a full database rebuild for JetIndex Destinations
  • 0
  • 1
    		•  rebuild=1

    Example Call JETAPI

    jetbackup5api -F runIntegrityCheck -D "_id={$DESTINATION_ID}&user_id=9879fde8573d0125563dc4b2"
    success: 1
message: Integrity check Added To The Queue
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=runIntegrityCheck&id={$DESTINATION_ID}