Skip to content

Siddhi Application Management APIs

Only available in runner distribution

Creating a Siddhi application

Overview

Description Creates a new Siddhi Application.
API Context /siddhi-apps
HTTP Method POST
Request/Response format Request : text/plain
Response : application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

curl command syntax

1
curl -X POST "https://localhost:9443/siddhi-apps" -H "accept: application/json" -H "Content-Type: text/plain" --data-binary @TestSiddhiApp.siddhi -u admin:admin -k

Sample curl command

1
curl -X POST "https://localhost:9443/siddhi-apps" -H "accept: application/json" -H "Content-Type: text/plain" --data-binary @TestSiddhiApp.siddhi -u admin:admin -k

Sample output

The response for the sample curl command given above can be one of the following.

  • If API request is valid and there is no existing Siddhi application with the given name, a response similar to the following is generated with response code 201. This response contains a location header with the path of the newly created file from product root home.

    1
    2
    3
    4
    {
        "type":"success",
        "message":"Siddhi App saved succesfully and will be deployed in next deployment cycle"
    }
    
  • If the API request is valid, but a Siddhi application with the given name already exists,  a response similar to the following is generated with response code 409.

    1
    2
    3
    4
    {
        "type": "conflict",
        "message": "There is a Siddhi App already exists with same name"
    }
    
  • If the API request is invalid due to invalid content in the Siddhi queries you have included in the request body,  a response similar to the following is generated is generated with response code 400.

    1
    2
    3
    4
    5
    {
        "code": 800101,
        "type": "validation error",
        "message": "You have an error in your SiddhiQL at line 8:8, missing INTO at 'BarStream'"
    }
    
  • If the API request is valid, but an exception occured during file processing or saving, the following response is generated with response code 500.

    1
    2
    3
    4
    5
    {
        "code": 800102,
        "type": "file processing error",
        "message": <error-message>
    }
    

Response

HTTP Status Code Possible codes are 201, 409, 400, and 500.
For descriptions of the HTTP status codes, see HTTP Status Codes

Updating a Siddhi Application

Overview

Description Updates a Siddhi Application.
API Context /siddhi-apps
HTTP Method PUT
Request/Response format Request : text/plain
Response : application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

curl command syntax

1
curl -X PUT "http://localhost:9090/siddhi-apps" -H "accept: application/json" -H "Content-Type: text/plain" --data-binary @<SIDDHI_APPLICATION_NAME>.siddhi -u admin:admin -k

Sample curl command

1
curl -X PUT "https://localhost:9443/siddhi-apps" -H "accept: application/json" -H "Content-Type: text/plain" --data-binary @TestSiddhiApp.siddhi -u admin:admin -k

Sample output

  • If the API request is invalid due to invalid content in the Siddhi query, a response similar to the following is returned with response code 400.

    1
    2
    3
    4
    5
    {
        "code": 800101,
        "type": "validation error",
        "message": "You have an error in your SiddhiQL at line 8:8, missing INTO at 'BarStream'" 
    }
    
  • If the API request is valid, but an exception occured when saving or processing files, a response similar to the following is returned with response code 500.

    1
    2
    3
    4
    5
    {
        "code": 800102,
        "type": "file processing error",
        "message": <error-message>
    }
    

Response

HTTP Status Code Possible codes are 200, 201, 400, and 500.
For descriptions of the HTTP status codes, see HTTP Status Codes

Deleting a Siddhi application

Overview

Description Sends the name of a Siddhi application as a URL parameter.
API Context /siddhi-apps/{appName}
HTTP Method DELETE
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

Parameter Description
{appName} The name of the Siddhi application to be deleted.

curl command syntax

1
curl -X DELETE "http://localhost:9090/siddhi-apps/{app-name}" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X DELETE "https://localhost:9443/siddhi-apps/TestSiddhiApp" -H "accept: application/json" -u admin:admin -k

Sample output

The response for the sample curl command given above can be one of the following:

  • If the API request is valid and a Siddhi application with the given name exists, a received with response code 200.

  • If the API request is valid, but a Siddhi application with the given name is not deployed, the following response is received with response code 404.

    1
    2
    3
    4
    {
        "type": "not found",
        "message": "There is no Siddhi App exist with provided name : TestExecutionPlan1" 
    }
    
  • If the API request is valid, but an exception occured when deleting the given Siddhi application, the following response is received with response code 500.

    1
    2
    3
    4
    5
    {
        "code": 800102,
        "type": "file processing error",
        "message": <error-message>
    }
    
  • If the API request is valid, but there are restricted characters in the given Siddhi application name, the following response is received with response code 400.

    1
    2
    3
    4
    5
    {
        "code": 800101,
        "type": "validation error",
        "message": "File name contains restricted path elements . : ../../siddhiApp2'" 
    }
    

Response

HTTP Status Code Possible codes are 200, 404, 400, and 500.
For descriptions of the HTTP status codes, see HTTP Status Codes

Listing all active Siddhi applications

Overview

Description

Lists all the currently active Siddhi applications.

If the isActive=true parameter is set, all the active Siddhi Applications are listed. If not, all the inactive Siddhi applications are listed.

API Context /siddhi-apps
HTTP Method GET
Request/Response format Request content type : any
Response content type : application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

curl command syntax

1
curl -X GET "http://localhost:9090/siddhi-apps" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X GET "https://localhost:9443/siddhi-apps?isActive=true" -H "accept: application/json" -u admin:admin -k

Sample output

Possible responses are as follows:

  • If the API request is valid and there are Siddhi applications deployed in your SP setup, a response similar to the following is returned with response code 200.

    1
    ["TestExecutionPlan3", "TestExecutionPlan4"]
    
  • If the API request is valid, there are Siddhi applications deployed in your SP setup, and a query parameter is defined in the request, a response similar to the following is returned with response code 200. This response only contains Siddhi applications that are active.

    If these conditions are met, but the isActive parameter is set to false , the response contains only inactive Siddhi applications.

    1
        ["TestExecutionPlan3"]
    
  • If the API request is valid, but there are no Siddhi applications deployed in your SP setup, the following response is returned.

    1
            []
    

Response

HTTP Status Code 200.
For descriptions of the HTTP status codes, see HTTP Status Codes

Retrieving a specific Siddhi application

Overview

Description Retrieves the given Siddhi application.
API Context /siddhi-apps/{appName}
HTTP Method GET
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

Parameter Description
{appName} The name of the Siddhi application to be retrieved.

curl command syntax

1
curl -X GET "http://localhost:9090/siddhi-apps/{app-name}" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X GET "https://localhost:9443/siddhi-apps/SiddhiTestApp" -H "accept: application/json" -u admin:admin -k

Sample output

The possible outputs are as follows:

  • If the API request is valid and a Siddhi application of the given name exists, a response similar to the following is returned with response code 200.

    1
    2
    3
    {
        "content": "\n@Plan:name('TestExecutionPlan')\ndefine stream FooStream (symbol string, price float, volume long);\n\n@source(type='inMemory', topic='symbol', @map(type='passThrough'))Define stream BarStream (symbol string, price float, volume long);\n\nfrom FooStream\nselect symbol, price, volume\ninsert into BarStream;" 
    }
    
  • If the API request is valid, but a Siddhi application of the given name is not deployed, a response similar to the following is returned with response code 404.

    1
    2
    3
    4
    {
        "type": "not found",
        "message": "There is no Siddhi App exist with provided name : TestExecutionPlan1" 
    }
    

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes

Fetching the status of a Siddhi Application

Overview

Description This fetches the status of the specified Siddhi application
API Context /siddhi-apps/{appName}/status
HTTP Method GET
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

Parameter Description
{appName} The name of the Siddhi application of which the status needs to be fetched.

curl command syntax

1
curl -X GET "http://localhost:9090/siddhi-apps/{app-file-name}/status" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X GET "https://localhost:9443/siddhi-apps/TestSiddhiApp/status" -H "accept: application/json" -u admin:admin -k

Sample output

  • If the Siddhi application is active, the following is returned with response code 200.

    1
    {"status":"active"} 
    
  • If the Siddhi application is inactive, the following is returned with response code 200.

    1
    {"status":"inactive"} 
    
  • If the Siddhi application does not exist, but the REST API call is valid, the following is returned with the response code 404.

    1
    2
    3
    4
    {
        "type": "not found",
        "message": "There is no Siddhi App exist with provided name : TestExecutionPlan1" 
    }
    

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes

Taking a snapshot of a Siddhi Application

Overview

Description This takes a snapshot of the specific Siddhi application.
API Context /siddhi-apps/{appName}/backup
HTTP Method POST
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

Parameter Description
{appName} The name of the Siddhi application of which a snapshot needs to be taken.

curl command syntax

1
curl -X POST "http://localhost:9090/siddhi-apps/{appName}/backup" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X POST "https://localhost:9443/siddhi-apps/TestSiddhiApp/backup" -H "accept: application/json" -u admin:admin -k

Sample output

The output can be one of the following:

  • If the API request is valid and a Siddhi application exists with the given name, an output similar to the following (i.e., with the snapshot revision number) is returned with response code 201.

    1
    {"revision": "89489242494242"} 
    
  • If the API request is valid, but no Siddhi application with the given name is deployed, an output similar to the following is returned with response code 404.

    1
    2
    3
    4
    {
        "type": "not found",
        "message": "There is no Siddhi App exist with provided name : TestExecutionPlan1" 
    }
    
  • If the API request is valid, but an exception has occured when backing up the state at Siddhi level, an output similar to the following is returned with response code 500.

    1
    2
    3
    4
    5
    {
        "code": 800102,
        "type": "file processing error",
        "message": <error-message>
    }
    

Response

HTTP Status Code Possible codes are 201, 404, and 500.
For descriptions of the HTTP status codes, see HTTP Status Codes

Restoring a Siddhi Application via a snapshot

!!! info "In order to call this API, you need to have already taken a snapshot of the Siddhi application to be restored. For more information about the API via which the snapshot is taken, see Taking a snapshot of a Siddhi Application .

Overview

Description

This restores a Siddhi application using a snapshot of the same that you have previously taken.

API Context

  • To restore without considering the version : /siddhi-apps/{appName}/restore
  • To restore a specific version : /siddhi-apps/{appName}/restore?version=

HTTP Method

POST

Request/Response format

application/json

Authentication

Basic

Username

admin

Password

admin

Runtime

Runner

Parameter Description

Parameter Description
{appName}
The name of the Siddhi application that needs to be restored.

curl command syntax

1
curl -X POST "http://localhost:9090/siddhi-apps/{appName}/restore" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X POST "https://localhost:9443/siddhi-apps/TestSiddhiApp/restore?revision=1514981290838_TestSiddhiApp" -H "accept: application/json" -u admin:admin -k

Sample output

The above sample curl command can generate either one of the following responses:

  • If the API request is valid, a Siddhi application with the given name exists, and no revision information is passed as a query parameter, the following response is returned with response code 200.

    1
    2
    3
    4
    {
        "type": "success",
        "message": "State restored to last revision for Siddhi App :TestExecutionPlan" 
    }
    
  • If the API request is valid, a Siddhi application with the given name exists, and revision information is passed as a query parameter, the following response is returned with response code 200. In this scenario, the Siddhi snapshot is created in the file system.

    1
    2
    3
    4
    {
        "type": "success",
        "message": "State restored to revision 1234563 for Siddhi App :TestExecutionPlan" 
    }
    
  • If the API request is valid, but no Siddhi application is deployed with the given name, the following response is returned with response code 404.

    1
    2
    3
    4
    {
        "type": "not found",
        "message": "There is no Siddhi App exist with provided name : TestExecutionPlan1" 
    }
    
  • If the API request is valid, but an exception occured when restoring the state at Siddhi level, the following response is returned with response code 500.

    1
    2
    3
    4
    5
    {
        "code": 800102,
        "type": "file processing error",
        "message": <error-message>
    }
    

Response

HTTP Status Code Possible codes are 200, 404, and 500.
For descriptions of the HTTP status codes, see HTTP Status Codes

Returning real-time statistics of a runner

Overview

Description Returns the real-time statistics of a runner.
API Context /statistics
HTTP Method GET
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

curl command syntax

1
curl -X GET "https://localhost:9443/statistics" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X GET "https://localhost:9443/statistics" -H "accept: application/json" -u admin:admin -k

Sample output

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes

Enabling/disabling runner statistics

Overview

Description Enables/diables generating statistics for runner nodes.
API Context /statistics
HTTP Method PUT
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

curl command syntax

1
curl -X PUT "https://localhost:9443/statistics" -H "accept: application/json" -H "Content-Type: application/json" -d "{“statsEnable”:”true”}" -u admin:admin -k

Sample curl command

1
curl -X PUT "https://localhost:9443/statistics" -H "accept: application/json" -H "Content-Type: application/json" -d "{“statsEnable”:”true”}" -u admin:admin -k

Sample output

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes

Returning general details of a runner

Overview

Description Returns general details of a runner.
API Context /system-details
HTTP Method GET
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

curl command syntax

1
curl -X GET "https://localhost:9443/system-details" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X GET "https://localhost:9443/system-details" -H "accept: application/json" -u admin:admin -k

Sample output

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes

Returning detailed statistics of all Siddhi applications

Overview

Description Returns the detailed statistics of all the Siddhi applications currently deployed in the SP setup.
API Context /siddhi-apps/statistics
HTTP Method GET
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

curl command syntax

1
curl -X GET "https://localhost:9443/siddhi-apps/statistics" -H "accept: application/json" -u admin:admin -k

Sample curl command

1
curl -X GET "https://localhost:9443/siddhi-apps/statistics" -H "accept: application/json" -u admin:admin -k

Sample output

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes

Enabling/disabling the statistics of a specific Siddhi application

Overview

Description Enables/disables statistics for a specified Siddhi application.
API Context /siddhi-apps/{appName}/statistics
HTTP Method PUT
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

Parameter Description
appName The name of the Siddhi application for which the Siddhi applications need to be enabled/disabled.

curl command syntax

1
curl -X PUT "https://localhost:9443/siddhi-apps/{appName}/statistics" -H "accept: application/json" -H "Content-Type: application/json" -d "{“statsEnable”:”true”}" -u admin:admin -k

Sample curl command

1
curl -X PUT "https://localhost:9443/siddhi-apps/TestSiddhiApp/statistics" -H "accept: application/json" -H "Content-Type: application/json" -d "{“statsEnable”:”true”}" -u admin:admin -k

Sample output

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes

Enabling/disabling the statistics of all Siddhi applications

Overview

Description Enables/disables statistics for all the Siddhi applications.
API Context /siddhi-apps/statistics
HTTP Method PUT
Request/Response format application/json
Authentication Basic
Username admin
Password admin
Runtime Runner

Parameter Description

curl command syntax

1
curl -X PUT "https://localhost:9443/siddhi-apps/statistics" -H "accept: application/json" -H "Content-Type: application/json" -d "{“statsEnable”:”true”}" -u admin:admin -k

Sample curl command

1
curl -X PUT "https://localhost:9443/siddhi-apps/statistics" -H "accept: application/json" -H "Content-Type: application/json" -d "{“statsEnable”:”true”}" -u admin:admin -k

Sample output

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes
Top