API reference
This topic is an index to the Apache® Druid API documentation.
Set druid.server.http.enableResponseIdentityHeaders to true to include headers on every HTTP response that identify
the Druid service which generated the response:
| Header | Description |
|---|---|
X-Druid-Server | Advertised host and port of the Druid server that generated the response. |
X-Druid-Service | Service name of that Druid server, as configured by druid.service. |
X-Druid-Version | Version of that Druid server. |
When a Router proxies a request, it passes through these headers from the upstream Druid server instead of returning the Router's identity. If the upstream server does not return all three headers, the Router does not return any of them. If the Router generates the response itself, the headers identify the Router.
This feature is disabled by default because the headers may expose internal hostnames, IP addresses, ports, and the Druid version. Only enable it when clients are authorized to receive this information.
HTTP APIs
- Druid SQL queries to submit SQL queries using the Druid SQL API.
- SQL-based ingestion to submit SQL-based batch ingestion requests.
- JSON querying to submit JSON-based native queries.
- Tasks to manage data ingestion operations.
- Supervisors to manage supervisors for data ingestion lifecycle and data processing.
- Retention rules to define and manage data retention rules across datasources.
- Data management to manage data segments.
- Automatic compaction to optimize segment sizes after ingestion.
- Lookups to manage and modify key-value datasources.
- Service status to monitor components within the Druid cluster.
- Dynamic configuration to configure the behavior of the Coordinator and Overlord processes.
- Legacy metadata to retrieve datasource metadata.
Java APIs
- Druid JDBC driver to connect to Druid and make Druid SQL queries over JDBC. This is the recommended JDBC driver.
- Avatica JDBC driver to make Druid SQL queries using the Apache Calcite Avatica driver instead.