Mirror/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-07-21 07:28:10 -07:00
Code Issues Packages Projects Releases Wiki Activity

Added blackhole methods to API docs

Browse Source
This commit is contained in:
Mark Qvist
2026-05-21 13:19:06 +02:00
parent a96a1d6692
commit 17f6968467
11 changed files with 85 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/markdown/reference.md
+21 -1
View File
@@ -1295,4 +1295,24 @@ will announce it.
* **Parameters:**
* **destination_hash** – A destination hash as *bytes*.
* **on_interface** – If specified, the path request will only be sent on this interface. In normal use, Reticulum handles this automatically, and this parameter should not be used.
* **on_interface** – If specified, the path request will only be sent on this interface. In normal use, Reticulum handles this automatically, and this parameter should not be used.
#### `static blackhole_identity(identity_hash, until=None, reason=None)`
Blackholes an identity.
* **Parameters:**
* **identity_hash** – The identity hash to blackhole as *bytes*.
* **until** – Optional unix timestamp of when the blackhole expires as *float* or *int*.
* **reason** – Optional reason for the blackhole as *str*.
* **Returns:**
*True* if successful, otherwise *False*.
#### `static unblackhole_identity(identity_hash)`
Lifts blackhole for an identity.
* **Parameters:**
**identity_hash** – The identity hash to blackhole as *bytes*.
* **Returns:**
*True* if successful, otherwise *False*.