Skip to main content
Version: v5.7.0

opschain entity delete

Included from Basic tier

opschain entity delete <entity-path> --confirm

Soft-deletes an entity and its child entities. Nothing is destroyed: the subtree is hidden from every list and read, the path stays reserved so nothing can silently take its place, and a restore undoes it completely.

Without --confirm the command reads the entity and only previews:

opschain entity delete shop/environments/prod/entities/orders_schema
would soft-delete entity /projects/shop/environments/prod/entities/orders_schema (0193b7aa-…)
the entity and its child entities become hidden and the path stays reserved;
nothing is destroyed and a restore undoes it.
re-run with --confirm to delete

With --confirm it deletes and prints the restore command:

deleted entity /projects/shop/environments/prod/entities/orders_schema — hidden and reserved; `opschain admin nodes restore /projects/shop/environments/prod/entities/orders_schema` undoes this

You need read and delete rights on the entity's path; without them it answers as not found. -o, --output json|yaml emits deleted (the path) and id.

Flags​

FlagMeaning
--confirmActually delete. Without it the command previews and exits 0.

Exit codes​

CodeMeaning
0Deleted, or previewed.
1The server refused — not found (missing, already deleted, or unreadable), or the embedded store.
2Usage error — an empty path, no server target.