entity-delete

dpsctl import entity-delete Usage Guide

Delete a stored entity import request and any stored results by request ID. The request ID is returned by dpsctl import entity.

Use this command after a request has completed, failed, or been cancelled and you no longer need its stored status or generated entities.

Usage

dpsctl import entity-delete --request-id <id>

Flags

Includes global dpsctl options.

   --request-id value                   Request ID returned by 'import entity' command (required)
   --help, -h                           show help

Examples

Delete a Stored Entity Import Request

$ dpsctl import entity-delete --request-id abc123-def456-ghi789
{
  "status": {
    "ok": true
  }
}

If you need to stop an in-flight request before deleting its stored state, cancel it first:

$ dpsctl import entity-cancel --request-id abc123-def456-ghi789
{
  "status": {
    "ok": true
  }
}

$ dpsctl import entity-delete --request-id abc123-def456-ghi789
{
  "status": {
    "ok": true
  }
}

Cancel vs Delete

• entity-cancel stops an entity generation request that is pending or running.
• entity-delete removes the stored request record and any stored generated entities.
• The server validates whether the request can be deleted and returns an error if it cannot.

Notes

• The --request-id flag is required.
• The request ID must be the value returned by dpsctl import entity.
• Use dpsctl import entity-status before deleting if you need to retrieve generated entities.
• Returns an error if the request ID is invalid, not found, or cannot be deleted.