Version: 17.07
UltraESB provides a simple REST API(Management Server) to manage and administer the internal components of UltraESB.
Management Server is started by default on port 8085
(to change the port
refer jetty.xml section). All the endpoints must
start with management
resource path.
Below section briefly explains the access endpoints provided by the UltraESB
Start UltraESB Server
Description |
This endpoint will issue the start command to the UltraESB Server |
HTTP Method |
|
Resource Path |
/management/server/start |
Success Response |
|
Stop UltraESB Server
Description |
This endpoint will issue the stop command to the UltraESB Server |
HTTP Method |
|
Resource Path |
/management/server/stop |
Success Response |
|
Check the status of the UltraESB Server
Description |
This endpoint can be used to check the current status of the UltraESB server |
HTTP Method |
|
Resource Path |
/management/server/status |
Success Response |
|
List all the projects
Description |
This endpoint can be used to list all the projects deployed and started within an UltraESB Server |
HTTP Method |
|
Resource Path |
/management/project |
Success Response |
|
Erroneous Response |
With |
Query single project
Description |
This endpoint can be used to view details of a particular project via its ID |
HTTP Method |
|
Resource Path |
/management/project/{projectID} |
Success Response |
|
Erroneous Response |
With |
Query an Integration Flow
Description |
This endpoint can be used to obtain the details of a particular Integration flow within a project through both project ID and integration flow ID |
HTTP Method |
|
Resource Path |
/management/project/{projectID}/{flowID} |
Success Response |
|
Erroneous Response |
With
With |
Enable Message Tracing
Description |
This endpoint can be used to enable message tracing which keeps track of the last message which went through the UltraESB |
HTTP Method |
|
Resource Path |
/management/message/trace |
Success Response |
|
Erroneous Response |
With |
Disable Message Tracing
Description |
This endpoint can be used to disable message tracing |
HTTP Method |
|
Resource Path |
/management/message/trace |
Success Response |
|
Erroneous Response |
With |
Get Message Tracing Status
Description |
This endpoint can be used to obtain the status of the message tracing |
HTTP Method |
|
Resource Path |
/management/message/trace |
Success Response |
|
Erroneous Response |
With |
Get message details received to a particular component
Description |
This endpoint can be used to obtain the details of a message received for a particular component |
HTTP Method |
|
Resource Path |
/management/message/{projectId}/{projectVersion}/{flowId}/{elementId}/received |
Success Response |
|
Erroneous Response |
With
With |
Obtain message execution path
Description |
This endpoint can be used to obtain the execution path of the last message which went through the UltraESB |
HTTP Method |
|
Resource Path |
/management/message/{projectId}/{projectVersion}/{flowId}/path |
Success Response |
|
Erroneous Response |
With |
Obtain message View
Description |
This endpoint can be used to obtain the details of a message which passed through the specified two components |
HTTP Method |
|
Resource Path |
/management/message/{projectId}/{projectVersion}/{flowId}/view |
Success Response |
|
Erroneous Response |
With
With |
Start Snapshot
Description |
This endpoint can be used to start taking the snapshot of the current status of the UltraESB |
HTTP Method |
|
Resource Path |
/management/snapshot |
Success Response |
|
Erroneous Response |
With |
Get status of Snapshot progress
Description |
This endpoint can be used to start taking the snapshot of the current status of the UltraESB |
HTTP Method |
|
Resource Path |
/management/snapshot/status |
Success Response |
|
Download Snapshot
Description |
This endpoint can be used to start taking the snapshot of the current status of the UltraESB |
HTTP Method |
|
Resource Path |
/management/snapshot |
Success Response |
Produce a ZIP file containing the configuration directory, logs directory and the project directory of the UltraESB |
Erroneous Response |
With
With |