The CLI purge status command

Version:

The xConnect DevEx CLI plugin includes a status subcommand. This command checks the progress of a registered purge task.

Usage

You can use the command as follows:

sitecore xconnect purge status [options]

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.

If you have suggestions for improving this article, let us know!