Remove Entity
remove_entitySoft-deletes one threat-model entity of any core type, creates a new model version, and preserves the entity ID so it can be restored with the same links.
Instructions
Soft-delete a single entity of any core type. Mutating: creates a
new model version. Reversible with restore_entity using the same
entity_type — the entity's ID is preserved (never reused) so a
restore reinstates the same ID and all its links. To change an
entity's fields instead of removing it, use the typed edit_* tool.
Runs as a background job, reporting progress while it waits; a job a client stops waiting for finishes or fails on its own. A removal that is refused (the entity is not found or already deleted, or it is the last live asset or attacker) fails with the reason.
Dispatches on entity_type. Per-type consequence (all derived at
read time; nothing is hard-destroyed):
asset— the asset's (asset × attacker) CO pairs are tombstoned, orphaning any controls mapped to them.attacker— control objectives anchored to this attacker are tombstoned; controls left with no live anchor become orphaned.component— controls scoped to this component have theircomponent_idcleared (the controls themselves are kept) and the component's trust-boundary contribution to asset reachability is withdrawn.trust_boundary— reachability widens: attacker vectors the boundary was filtering now pass freely and itssealed/isolation claim is dropped, so CO reachability verdicts past it can flip toward reachable/indeterminate.assumption— marked deleted (kept for the audit trail); its CO links are cleared and its attestations retired; controls whoseassumption_groupsname it keep their groups, which credit nothing through it while it is deleted.
Returns {model, entities, controls_carried, controls_orphaned, orphaned_control_ids}: the model's id, version and title, and the
entity as removed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| model_id | Yes | ID of the threat model. | |
| entity_id | Yes | ID of the entity to soft-delete. | |
| entity_type | Yes | Which entity to soft-delete — one of ``asset``, ``attacker``, ``component``, ``trust_boundary``, ``assumption``. | |
| server_version | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||