Skip to content

Overview

Concepts and Principles

Development

Overview

IDEs

API Explorer

Releases

Release Notes

TORO Integrate

Coder Studio

Coder Cloud

Bug Reports

Search

ESB API

TORO Integrate ships with a built-in REST API that you can use to remotely administer and maintain your TORO Integrate instances. The API includes many functions that allows maintenance of things such as:

The API also includes support for system functions such as:

The REST API is also exposed as a Swagger file (accessible at the URL <toro-integrate-home>/api-docs/json/swagger), meaning you can test the API in API Explorer, or generate Gloop client services from it. The swagger file also contains documentation for each operation in case you need more information on a particular operation or API.

A screenshot of the API Explorer displaying an operation.

Ad-hoc REST Operations

If you have exposed a Gloop or Groovy Service using the Ad-hoc REST feature or a @RequestMapping annotation, they will also appear in the built-in admin API.

Permissions Regarding the Administration API

This API is only accessible when you have logged in to TORO Integrate using your TORO Marketplace account, or when authenticated using an Integrate User that belongs to the ESBAPIAdminGroup group. If this group doesn't already exist, you can create the group and add your desired user account to it.