This documentation is for WSO2 Stream Processor 4.2.0. View documentation for the latest release.

All docs This doc
||
Skip to end of metadata
Go to start of metadata

There are two sets of REST APIs available in worker runtime. Stream Processor APIs and Event Simulator APIs have following permission model. You need to have appropriate permission to invoke these APIS.

Stream Processor  APIs

MethodAPI ContextRequired Permission
POST/siddhi-apps

PermissionString - siddhiApp.manage

AppName - SAPP

PUT/siddhi-apps

PermissionString - siddhiApp.manage

AppName - SAPP

DELETE/siddhi-apps/{appName}

PermissionString - siddhiApp.manage

AppName - SAPP

GET/siddhi-apps

PermissionString - siddhiApp.manage or siddhiApp.view

AppName - SAPP

GET/siddhi-apps/{appName}

PermissionString - siddhiApp.manage or siddhiApp.view

AppName - SAPP

GET/siddhi-apps/{appName}/status

PermissionString - siddhiApp.manage or siddhiApp.view

AppName - SAPP

POST/siddhi-apps/{appName}/backup

PermissionString - siddhiApp.manage

AppName - SAPP

POST

/siddhi-apps/{appName}/restore

/siddhi-apps/{appName}/restore?version=

PermissionString - siddhiApp.manage

AppName - SAPP

GET/statistics

PermissionString - siddhiApp.manage or siddhiApp.view

AppName - SAPP

PUT/statistics

PermissionString - siddhiApp.manage

AppName - SAPP

GET/system-details

PermissionString - siddhiApp.manage or siddhiApp.view

AppName - SAPP

GET/siddhi-apps/statistics

PermissionString - siddhiApp.manage or siddhiApp.view

AppName - SAPP

PUT/siddhi-apps/{appName}/statistics

PermissionString - siddhiApp.manage

AppName - SAPP

PUT/siddhi-apps/statistics

PermissionString - siddhiApp.manage

AppName - SAPP


Event Simulator APIs

MethodAPI ContextRequired Permission
POST/simulation/single

PermissionString - simulator.manage

AppName - SIM

POST/simulation/feed

PermissionString - simulator.manage

AppName - SIM

GET/simulation/feed

PermissionString - simulator.manage or simulator.view

AppName - SIM

PUT/simulation/feed/{simulationName}

PermissionString - simulator.manage

AppName - SIM

GET/simulation/feed/{simulationName}

PermissionString - simulator.manage or simulator.view

AppName - SIM

DELETE/simulation/feed/{simulationName}

PermissionString - simulator.manage

AppName - SIM

POST/simulation/feed/{simulationName}?action=run

PermissionString - simulator.manage

AppName - SIM

POST/simulation/feed/{simulationName}?action=pause

PermissionString - simulator.manage

AppName - SIM

POST/simulation/feed/{simulationName}?action=stop

PermissionString - simulator.manage

AppName - SIM

POST/simulation/feed/{simulationName}?action=resume

PermissionString - simulator.manage

AppName - SIM

GET/simulation/feed/{simulationName}/status

PermissionString - simulator.manage or simulator.view

AppName - SIM

POST/simulation/files

PermissionString - simulator.manage

AppName - SIM

GET/simulation/files

PermissionString - simulator.manage or simulator.view

AppName - SIM

PUT/simulation/files/{fileName}

PermissionString - simulator.manage

AppName - SIM

DELETE/simulation/files/{fileName}

PermissionString - simulator.manage

AppName - SIM

POST/simulation/connectToDatabase

PermissionString - simulator.manage

AppName - SIM

POST/simulation/connectToDatabase/retrieveTableNames

PermissionString - simulator.manage

AppName - SIM

POST/simulation/connectToDatabase/{tableName}/retrieveColumnNames

PermissionString - simulator.manage

AppName - SIM


simulator
  • No labels