aboutsummaryrefslogtreecommitdiff
path: root/doc/REST-interface.md
diff options
context:
space:
mode:
authorFabian Jahr <fjahr@protonmail.com>2020-05-22 16:10:46 +0200
committerFabian Jahr <fjahr@protonmail.com>2020-06-01 00:54:18 +0200
commit5c3eaf9983043db1b61a98c95d692a6958670b86 (patch)
tree7ba7d4aa9cb1e12e7fb3904af76fb47f74c8e501 /doc/REST-interface.md
parentdc5333d31f280e09bb1e8cdacfbe842f4ab9e69b (diff)
doc: Add warnings for http interfaces limitations
Diffstat (limited to 'doc/REST-interface.md')
-rw-r--r--doc/REST-interface.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index 11e9c90f49..a34832082a 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -12,6 +12,18 @@ REST Interface consistency guarantees
The [same guarantees as for the RPC Interface](/doc/JSON-RPC-interface.md#rpc-consistency-guarantees)
apply.
+Limitations
+-----------
+
+There is a known issue in the REST interface that can cause a node to crash if
+too many http connections are being opened at the same time because the system runs
+out of available file descriptors. To prevent this from happening you might
+want to increase the number of maximum allowed file descriptors in your system
+and try to prevent opening too many connections to your rest interface at the
+same time if this is under your control. It is hard to give general advice
+since this depends on your system but if you make several hundred requests at
+once you are definitely at risk of encountering this issue.
+
Supported API
-------------