From 2a2b5e35ee046ea33a900dcb83bd360e3d0e170f Mon Sep 17 00:00:00 2001
From: "opensearch-trigger-bot[bot]"
 <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com>
Date: Wed, 4 Dec 2024 14:07:22 +0000
Subject: [PATCH] Document the `X-Opaque-Id` header (#8820) (#8875)

---
 _api-reference/common-parameters.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/_api-reference/common-parameters.md b/_api-reference/common-parameters.md
index 5b536ad992..ac3efbf4bf 100644
--- a/_api-reference/common-parameters.md
+++ b/_api-reference/common-parameters.md
@@ -123,4 +123,17 @@ Kilometers | `km` or `kilometers`
 Meters | `m` or `meters`
 Centimeters | `cm` or `centimeters`
 Millimeters | `mm` or `millimeters`
-Nautical miles | `NM`, `nmi`, or `nauticalmiles` 
\ No newline at end of file
+Nautical miles | `NM`, `nmi`, or `nauticalmiles` 
+
+## `X-Opaque-Id` header
+
+You can specify an opaque identifier for any request using the `X-Opaque-Id` header. This identifier is used to track tasks and deduplicate deprecation warnings in server-side logs. This identifier is used to differentiate between callers sending requests to your OpenSearch cluster. Do not specify a unique value per request.
+
+#### Example request
+
+The following request adds an opaque ID to the request:
+
+```json
+curl -H "X-Opaque-Id: my-curl-client-1" -XGET localhost:9200/_tasks
+```
+{% include copy.html %}