Home / Knowledge base / 7. COMMANDS TO BE USED / 7.8 Remove Capture Process

7.8 Remove Capture Process

The “remove” Capture Process command is used to remove all of the Capture Process configuration files, Trail Files and the checkpoint information.

For MS SQL Server Database if the Source Database is reachable the “remove”command will disable CDC on the tables, which are configured to be captured by this Process only.

The command can only be executed if the specified Capture Process is not running. 

It is strongly recommended that you backup all Trail and configuration files before running this command (see chapter 9.4 Backup Repstance Files).

Note After removing the Capture Process it is not possible to reverse this action.

Any Apply Processes using data from this Capture will cease to work.

This command cannot be applied to a group of “Configures” at the same time, it must be used individually for each of the configured Capture Processes.


  • Endpoint: https://repstance_url/configure/process
  • Method: POST
  • Header:
    • Content-Type: application/json
    • X-Token: token
  • Body:
      "command": "remove",
      "parameters": [

Server response:

  • HTTP Status – status of the command, possible codes are:
    • 200 – if no error occurs
    • 422 – if error occurs
  • Body:
      "Message":"The command execution details",

CLI Syntax:

repcli remove process=capture id=captureID

The input parameters are:

  • process – The only possible value is capture
  • id – The identifier of the Capture Process

The output parameters are:

  • Status – Status of the command, possible values are:
    • Error – the command has failed to run
    • Warning – the process has failed to remove all the Capture objects
    • Completed – the command has completed successfully
  • Message – The details of command execution

The following example demonstrates how to remove Capture 2:

repcli remove process=capture id=2