Artifact


Deletes the Siddhi Application.
DELETE http://analytics.wso2.com/siddhi-apps/siddhi-apps/{appName}

Removes the currently deployed Siddhi Application with the name specified. Path param of **appName** determines name of the Siddhi application.

OAuth 2.0 Scope

Not required

Request

DELETE http://analytics.wso2.com/siddhi-apps/siddhi-apps/{appName}

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

appName

required

The name of the Siddhi Application.

String

Responses

HTTP Code Description Schema

200

The Siddhi Application is successfully deleted.

400

The Siddhi Application name provided is invalid.

ApiResponseMessageWithCode

404

The Siddhi Application is not found.

ApiResponseMessageWithCode

500

An unexpected error occured.

ApiResponseMessageWithCode

Retrieves the specified Siddhi Application.
GET http://analytics.wso2.com/siddhi-apps/siddhi-apps/{appName}

Retrieves the Siddhi Application with the specified name.

OAuth 2.0 Scope

Not required

Request

GET http://analytics.wso2.com/siddhi-apps/siddhi-apps/{appName}

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

appName

required

The name of the Siddhi Application.

String

Responses

HTTP Code Description Schema

200

The Siddhi Application is successfully retrieved.

SiddhiAppContent

404

The Siddhi Application specified is not found.

ApiResponseMessageWithCode

Fetches the status of the Siddhi Application.
GET http://analytics.wso2.com/siddhi-apps/siddhi-apps/{appName}/status

Fetches the status of the Siddhi Application.

OAuth 2.0 Scope

Not required

Request

GET http://analytics.wso2.com/siddhi-apps/siddhi-apps/{appName}/status

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

appName

required

The name of the Siddhi Application.

String

Responses

HTTP Code Description Schema

200

The state of the Siddhi Application is successfully retrieved.

SiddhiAppStatus

404

The Siddhi Application specified is not found.

ApiResponseMessageWithCode

Lists Siddhi Applications.
GET http://analytics.wso2.com/siddhi-apps/siddhi-apps

Provides the name list of Siddhi Applications that exist.

OAuth 2.0 Scope

Not required

Request

GET http://analytics.wso2.com/siddhi-apps/siddhi-apps

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Query

isActive

optional

Retrieves only active/inactive Siddhi Applications as specified.

Boolean

Responses

HTTP Code Description Schema

200

The Siddhi Applications are successfully retrieved.


Saves the Siddhi Application.
POST http://analytics.wso2.com/siddhi-apps/siddhi-apps

Saves the Siddhi Application. Request "**siddhiApp** explains the Siddhi Query.

OAuth 2.0 Scope

Not required

Request

POST http://analytics.wso2.com/siddhi-apps/siddhi-apps

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Body

body

required

Siddhi Application

String (string)

Responses

HTTP Code Description Schema

201

The Siddhi Application is successfully validated and saved.

400

A validation error occured.

409

A Siddhi Application with the given name already exists.

500

An unexpected error occured.


Updates the Siddhi Application.
PUT http://analytics.wso2.com/siddhi-apps/siddhi-apps

Updates the Siddhi Application. Request "**siddhiApp** explains the Siddhi Query.

OAuth 2.0 Scope

Not required

Request

PUT http://analytics.wso2.com/siddhi-apps/siddhi-apps

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Body

body

required

Siddhi Application

String (string)

Responses

HTTP Code Description Schema

200

The Siddhi Application is successfully validated and updated.

201

The Siddhi Application is successfully validated and saved.

400

A validation error occured.

ApiResponseMessageWithCode

500

An unexpected error occured.

ApiResponseMessageWithCode