Skip to main content

Delete Node

DELETE 
/nodes/:id

Soft-deletes a node. The node must be in Lost or Disconnected state unless force is used.

How It Works​

  1. Soft Delete: Node enters Deleted state immediately, hidden from normal lists
  2. Audit Trail: Node record preserved with full history
  3. Garbage Collection: After retention period, GC permanently removes node from database
  4. Execution Cleanup: GC waits until all node executions are cleaned up before permanent deletion

State Requirements​

  • Lost nodes: Can be deleted immediately (recommended)
  • Disconnected nodes: Can be deleted immediately
  • Connected nodes: Require force=true (use with caution)

Warning: Connected Nodes​

Deleting a Connected node with force=true should only be used when:

  • Node is permanently offline but showing as connected due to stale state
  • You're certain the node will not reconnect
  • If the node reconnects, it will be re-registered automatically

Common Patterns​

  • Decommission lost node: DELETE /nodes/{id}
  • Remove offline node: DELETE /nodes/{id}
  • Force delete stuck node: DELETE /nodes/{id} with {"force": true}

Request​

Responses​

OK