Skip to content

Commit

Permalink
Document the X-Opaque-Id header (#8820) (#8875)
Browse files Browse the repository at this point in the history
  • Loading branch information
opensearch-trigger-bot[bot] authored Dec 4, 2024
1 parent 908f1f4 commit 2a2b5e3
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion _api-reference/common-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
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 %}

0 comments on commit 2a2b5e3

Please sign in to comment.