Document 429 handling generically (elastic#105700)

We only had a few mentions of 429 handling, now documenting our expectation generically. Co-authored-by: David Turner <[email protected]> Co-authored-by: Liam Thompson <[email protected]>
henningandersen · Mar 1, 2024 · aeb91e5 · aeb91e5
1 parent 66ec625
commit aeb91e5
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc
@@ -302,6 +302,14 @@ Content-Type: application/vnd.elasticsearch+json; compatible-with=7
 Accept: application/vnd.elasticsearch+json; compatible-with=7
 ----------------------------------------------------------------------
 
+[discrete]
+[[api-push-back]]
+=== HTTP `429 Too Many Requests` status code push back
+
+{es} APIs may respond with the HTTP `429 Too Many Requests` status code, indicating that the cluster is too busy
+to handle the request. When this happens, consider retrying after a short delay. If the retry also receives
+a `429 Too Many Requests` response, extend the delay by backing off exponentially before each subsequent retry.
+
 [discrete]
 [[api-url-access-control]]
 === URL-based access control