Skip to content





API Explorer

Starting Up, Shutting Down, and Restarting TORO Integrate

This page will show you how to start up, shutdown, and restart TORO Integrate. We have provided a variety of ways to do these operations:

Using the CLI Script

One of the most common ways to start and stop TORO Integrate is by executing the CLI script that we have provided. You can also pass arguments to the following scripts to specify how you want to start TORO Integrate.

  • For Windows: <toro-integrate-home>/bin/toro-integrate.bat
  • For Unix or macOS: <toro-integrate-home>/bin/toro-integrate
Argument Description
run Default. Starts TORO Integrate.
start Starts TORO Integrate without outputting the logs in the terminal.
debug Starts TORO Integrate in debug mode.
stop Shutdown TORO Integrate.

For example:

$ <toro-integrate-home>/bin/toro-integrate run

Using the CLI Tool

The shutdown and restart commands are also available in the CLI tool. Take note that in order to use these commands, the CLI tool needs to be connected to a TORO Integrate instance.

Command Description
shutdown Shuts down the application
restart Restarts the application

The --now argument is required for both commands.

Using the Server Admin UI

The Server Admin UI also provides a way to shutdown or restart a TORO Integrate instance. To do this, click the power icon in the top right of the page (beside the user icon) and choose shutdown/restart.

Server Admin UI, shutdown & restart button

Using Coder Studio

Shutdown and restart operations are provided in Coder Studio. To shutdown or restart TORO Integrate via Coder Studio follow these steps:

  1. Right click the TORO Integrate instance in Coder Navigator view; this will show the context menu with the actions we can do for the instance.

  2. Select shutdown/restart.

    Instance context menu

Using REST Endpoints

TORO Integrate also provides REST endpoints for shutting down and restarting. Send a PUT request to the following endpoints to shutdown or restart TORO Integrate.

  • <toro-integrate-base-url>/esbapi/system/shutdown
  • <toro-integrate-base-url>/esbapi/system/restart

Authentication required

The endpoints above require authentication. You can read more about supported authentication schemes, which are Basic and OAuth2.