Skip to content
XTDB

HTTP Server

Note
 For more information on making calls to the HTTP server, see the HTTP API

The HTTP server opens an XTDB node to a port on localhost - forwarding the node incoming HTTP requests.

Setup

Ensure the com.xtdb/xtdb-http-server Maven dependency is added to your XTDB node.

Configuration

To use the HTTP Server module, include the following in your node configuration:

modules:
  - !HttpServer
    # -- optional

    # The port to listen for requests on
    # port: 3000

If you do not configure a port, the HTTP server will be started on port 3000 by default.

Examples

Clojure Kotlin

For examples on how to enable/configure the HTTP Server module as part of your node, for each client library, see the individual driver documentation: