Skip to content

Streaming Ingest API 4.14.7⚓︎

This API is used for sending data directly to Hydrolix for immediate ingestion. For more information, see the detailed documentation

Contact: Hydrolix Support support@hydrolix.net

Servers⚓︎

Description URL
https://{hostname} https://{hostname}

Ingest⚓︎

POST /ingest/event⚓︎

Streaming Ingest API

Description

This API is used for sending data directly to Hydrolix for immediate ingestion. This description describes an ingest event where the project, table and transform are already created and the data being sent is within a file. For more information, see the documentation for other methods including self- described messaging. Header specifications for table and transform can be utilized as well as Query String parameters.

Input parameters

Parameter In Type Default Nullable Description
content-encoding header string No The encoded format of the file. For example, gzip.
table query string No The table name to send the data to, in the format .. [Query Strings](https://docs.hydrolix.io/latest/self-managed/load-data/streaming-ingest/streaming-http/#using-query-strings)
transform query string No The transform name to use to encode the data. [Query Strings](https://docs.hydrolix.io/latest/self-managed/load-data/streaming-ingest/streaming-http/#using-query-strings)
x-hdx-table header string No The table name to send the data to, in the format .. [HTTP Headers](https://docs.hydrolix.io/latest/self-managed/load-data/streaming-ingest/streaming-http/#http-headers)
X-hdx-test header boolean No A debug flag that can be used to output what the data would have looked like if it had been indexed. More information here - [Streaming Debug](https://docs.hydrolix.io/latest/self-managed/load-data/streaming-ingest/streaming-http/#debug-headers-optional)
x-hdx-transform header string No The name of the transform to use with the data. [HTTP Headers](https://docs.hydrolix.io/latest/self-managed/load-data/streaming-ingest/streaming-http/#http-headers)

Request body

Schema of the request body 
1
2
3
4
5
{
    "type": "object",
    "format": "binary",
    "description": "A file in one of the supported formats - [Supported Payloads](https://docs.hydrolix.io/latest/self-managed/load-data/streaming-ingest/streaming-http/#supported-payloads)"
}
Schema of the request body 
1
2
3
4
{
    "type": "object",
    "format": "binary"
}

Response 200 OK

Response 207 Multi-Status

Response 400 Bad Request

Response 429 Too Many Requests

Response 502 Bad Gateway

Response 503 Service Unavailable