---
title: "The CLI purge cancel command"
slug: "the-cli-purge-cancel-command"
abstract: "Reference of the xConnect DevEx CLI cancel command that stops purge tasks."
---
# The CLI purge cancel command

The [xConnect DevEx CLI plugin](https://doc.sitecore.com/xp/en/developers/101/sitecore-experience-platform/xconnect-devex-cli-plugin.html "xConnect DevEx CLI plugin") includes a `cancel` subcommand. This command cancels the progress of a [registered](https://doc.sitecore.com/xp/en/developers/101/sitecore-experience-platform/the-cli-purge-contacts-command.html "The CLI purge contacts command") purge task.

<details>
<summary><h2>Usage</h2></summary>

You can use the command as follows:

```text
sitecore xconnect purge cancel [options]

```

</details>

<details>
<summary><h2>Options</h2></summary>

You can use the following options with the command:

| Option | Required? | Description |
| --- | --- | --- |
| `-c, --config` | Yes | The path to the `sitecore.json` configuration file (default: cwd). A DevEx CLI standard option. |
| `-n, --environment-name` | Yes | The Sitecore environment to use. Default: `default`. A DevEx CLI standard option. |
| `--pti, --processing-task-id` | Yes | The unique identifier of the ongoing purge task. |
| `-v, --verbose` | No | Report additional diagnostic and performance data. |
| `-t, --trace` | No | Report additional diagnostic and performance data. |
| `-?, -h, --help` | No | Help for the command. |

> [!note]
> You can only cancel the task if it is in the Pending or In Progress state. Otherwise, the command returns an error. Use the [status](https://doc.sitecore.com/xp/en/developers/101/sitecore-experience-platform/the-cli-purge-status-command.html "The CLI purge status command") command to retrieve the current state of the task.

</details>