This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
All Data Prepper instances expose a server with some control APIs. By default, this server runs on port 4900. Some plugins, especially source plugins, may expose other servers that run on different ports. Configurations for these plugins are independent of the core API. For example, to shut down Data Prepper, you can run the following curl request:
curl -X POST http://localhost:4900/shutdown
The following table lists the available APIs.
| ||Returns a list of running pipelines.|
| ||Starts a graceful shutdown of Data Prepper.|
| ||Returns a scrape of Data Prepper metrics in Prometheus text format. This API is available as a |
| ||Returns JVM metrics in Prometheus text format. This API is available as a |
Configuring the server
You can configure your Data Prepper core APIs through the
Many of the getting started guides for this project disable SSL on the endpoint:
To enable SSL on your Data Prepper endpoint, configure your
data-prepper-config.yaml file with the following options:
ssl: true keyStoreFilePath: "/usr/share/data-prepper/keystore.p12" keyStorePassword: "secret" privateKeyPassword: "secret"
For more information about configuring your Data Prepper server with SSL, see Server Configuration. If you are using a self-signed certificate, you can add the
-k flag to the request to quickly test core APIs with SSL. Use the following
shutdown request to test core APIs with SSL:
curl -k -X POST https://localhost:4900/shutdown
The Data Prepper core APIs support HTTP basic authentication. You can set the username and password with the following configuration in the
authentication: http_basic: username: "myuser" password: "mys3cr3t"
You can disable authentication of core endpoints using the following configuration. Use this with caution because the shutdown API and others will be accessible to anybody with network access to your Data Prepper instance.
Peer Forwarder can be configured to enable stateful aggregation across multiple Data Prepper nodes. For more information about configuring Peer Forwarder, see Peer forwarder. It is supported by the
When you run the Data Prepper
shutdown API, the process gracefully shuts down and clears any remaining data for both the
ExecutorService sink and
ExecutorService processor. The default timeout for shutdown of both processes is 10 seconds. You can configure the timeout with the following optional
data-prepper-config.yaml file parameters:
processorShutdownTimeout: "PT15M" sinkShutdownTimeout: 30s
The values for these parameters are parsed into a
Duration object through the Data Prepper Duration Deserializer.