API Reference

eKuiper provides a set of REST API for streams and rules management in addition to CLI.

By default, the REST API are running in port 9081. You can change the port in /etc/kuiper.yaml for the restPort property.

Getting information

This API is used to get the version number, system type, and program running time.

GET http://localhost:9081

{
"version": "1.0.1-22-g119ee91",
"os": "darwin",
"upTimeSeconds": 14
}

ping

GET http://localhost:9081/ping

Batch request

This API is used to merge multiple requests into one request and send it for execution

POST http://localhost:9081/batch/req

[
    {
        "method": "POST",
        "path": "/streams",
        "body": "{\"sql\":\"CREATE stream demobatch() WITH (DATASOURCE=\\\"/data1\\\", TYPE=\\\"websocket\\\")\"}"
    },
    {
        "method": "GET",
        "path": "/streams/demobatch"
    }
]

Response

[
    {
        "code": 201,
        "response": "Stream demobatch is created."
    },
    {
        "code": 200,
        "response": "{\"Name\":\"demobatch\",\"StreamFields\":null,\"Options\":{\"datasource\":\"/data1\",\"type\":\"websocket\"},\"StreamType\":0,\"Statement\":null}"
    }
]

• Streams
• Rules
• Plugins