http adding endpoint to ingest data with (opensearch-project#8067)

* Documented the endpoint that is used with this option. Signed-off-by: Landon Lengyel <[email protected]> * Update _data-prepper/pipelines/configuration/sources/http.md Signed-off-by: Melissa Vagi <[email protected]> * Update _data-prepper/pipelines/configuration/sources/http.md Signed-off-by: Melissa Vagi <[email protected]> * Update _data-prepper/pipelines/configuration/sources/http.md Signed-off-by: Melissa Vagi <[email protected]> * Update _data-prepper/pipelines/configuration/sources/http.md Signed-off-by: Melissa Vagi <[email protected]> * Update http.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update http.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]>
leanneeliatra · Sep 13, 2024 · 360908b · 360908b
1 parent c9bd6fe
commit 360908b
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/_data-prepper/pipelines/configuration/sources/http.md b/_data-prepper/pipelines/configuration/sources/http.md
@@ -10,7 +10,7 @@ redirect_from:
 
 # http
 
-The `http` plugin accepts HTTP requests from clients. Currently, `http` only supports the JSON UTF-8 codec for incoming requests, such as `[{"key1": "value1"}, {"key2": "value2"}]`. The following table describes options you can use to configure the `http` source.
+The `http` plugin accepts HTTP requests from clients. The following table describes options you can use to configure the `http` source.
 
 Option | Required | Type | Description
 :--- | :--- | :--- | :---
@@ -36,6 +36,19 @@ aws_region | Conditionally | String | AWS region used by ACM or Amazon S3. Requi
 
 Content will be added to this section.--->
 
+## Ingestion
+
+Clients should send HTTP `POST` requests to the endpoint `/log/ingest`.
+
+The `http` protocol only supports the JSON UTF-8 codec for incoming requests, for example, `[{"key1": "value1"}, {"key2": "value2"}]`.
+
+#### Example: Ingest data with cURL
+
+The following cURL command can be used to ingest data:
+
+`curl "http://localhost:2021/log/ingest" --data '[{"key1": "value1"}, {"key2": "value2"}]'`
+{% include copy-curl.html %}
+
 ## Metrics
 
 The `http` source includes the following metrics.