Introduction

This page acts as the specification for the OpenESB Rest API

URL mapping

By default, root URL is http://localhost:4848/openesb

The WADL is available through http://localhost:4848/openesb/application.wadl

URL	Method	Description	MediaType	State
Global
/	GET	View OpenESB runtime informations : build number, copyright, full product name, instance name, version, system info.

Service Assemblies
/assemblies?state=any\|started\|stopped\|shutdown&component=name_of_a_component	GET	List service assemblies
/assemblies	PUT	Install a service assembly	multipart/form-data
/assemblies/{assemblyName}	GET	Return service assembly informations
/assemblies/{assemblyName}/descriptor	GET	Return the XML descriptor for the service assembly
/assemblies/{assemblyName}/action/start	GET	Start the service assembly
/assemblies/{assemblyName}/action/stop	GET	Stop the service assembly
/assemblies/{assemblyName}/action/shutdown?force=true\|false	GET	Shutdown the service assembly
/assemblies/{assemblyName}	DELETE	Undeploy the service assembly
/assemblies/{assemblyName}/stats	GET	View service assemblies statistics		TODO

JBI Components (BC / SE)
/components?type=binding\|engine&state=any\|started\|stopped\|shutdown&library=sl_name&assembly=sa_name	GET	List binding components / service engines
/components	PUT	Install a JBI Component	multipart/form-data
/components/{componentName}	GET	Return informations about components
/components/{componentName}/descriptor	GET	Return the XML descriptor for the component
/components/{componentName}/action/start	GET	Start component.
/components/{componentName}/action/stop	GET	Stop component.
/components/{componentName}/action/shutdown?force=true\|false	GET	Shutdown component.
/components/{componentName}	DELETE	Undeploy JBI components		TODO
/components/{componentName}/endpoints	GET	List active endpoints / active consuming endpoints for the component
/components/{componentName}/endpoints/in	GET	List active consuming endpoints for the component
/components/{componentName}/endpoints/out	GET	List active endpoints for the component
/components/{componentName}/endpoints/stats	POST	View endpoint statistics	application/x-www-form-urlencoded
/components/{componentName}/configuration	GET	Retrieve the component's configuration
/components/{componentName}/variables	GET	Retrieves the component's application variables
/components/{componentName}/loggers	GET	Retrieves the component's loggers

Shared Libraries
/libraries?component=name_of_a_component	GET	List shared libraries
/libraries/{libraryName}	GET	Return informations about the shared library
/libraries/{libraryName}/descriptor	GET	Return the XML descriptor for the shared library

NMR
/nmr	GET	Informations about NMR : active channels / active endpoints / last restart time / ...
/nmr/stats	GET	Messaging statistics		TODO
/nmr/endpoints	GET	List active endpoints / active consuming endpoints registered in the NMR
/nmr/endpoints/in	GET	List active consuming endpoints registered in the NMR
/nmr/endpoints/out	GET	List active endpoints registered in the NMR

OpenESB

Rest API

Analytics

Introduction

URL mapping

Related content