Loading TOC...

xdmp.databaseBackupCancel

xdmp.databaseBackupCancel(
   $jobid as (Number|String)
) as Boolean

Summary

Cancels an outstanding backup job with the specified job ID, returning true if the cancel operation is successful, false if the cancel operation is not successful. The xdmp.databaseBackupCancel function must be run on the host in which the backup was initiated.

Parameters
$jobid A backup job ID. You can find the job IDs for running backups by calling xdmp.hostStatus and looking in the backupJobs property.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/xdmp-database-backup-cancel

http://marklogic.com/xdmp/privileges/xdmp-database-backup-cancel/database/{id}

Example

xdmp.databaseBackupCancel(3303087797980181348)
=> true

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.