Managing Resources by using administration REST API in ACE

IBM ACE has provided the facility of REST API which you can use to administer integration nodes, integration servers and other resources which is supported on Windows/Linux/AIX platforms.

        The classes and methods available can be viewed in the REST API v2 specification using the URL http(s)://<hostName>:<port>/apidocs where hostName is the host name/ip of the machine where your Integration Node or Integration server is running, port is the REST API port specified in node.conf.yaml file in case of Integration Node or server.config.yaml in case of Integration server (standalone).

Below are the screenshots of two scenarios [one with Integration node and one with integration server only]

Integration Node REST API docs

 Integration Server REST API docs

Get Details:

Let us take an example of GET /apiv2. This API will retrieve the Integration Node Object details in JSON format. 

If you look at the example request format, you will see multiple options supported curl/ruby/python/php/java/node/go/swift. 

The examples provided is useful if you want to invoke the REST API from any of these languages.

In order to test this API, click on Try It button, enter user and password if basic auth is enabled and click on Send button.

The response obtained consists of Integration Node object properties

Stop Server scenario:

Let us now take an another example of stopping an Integration Server using REST API.

For this we need to make use of apiv2/servers/{server}/stop REST API  to stop integration server

As mentioned in earlier scenario, open the apiv2/servers/{server}/stop API, click on Try It, enter the Server name that you want to stop and click on Send button. The integration server will get stopped.

These are just two out of many REST API's provided by the ACE. For example, there are REST APIs for viewing the properties of Node/Server/Applications/Flows/Nodes(nodes in toolkit).

Likewise there are properties to add/update/delete the properties accordingly. Overall there are 490+ REST APIs that one can use to work on. 

I have listed only 2 of the 490+ APIs for reference. You can check for other REST APIs and explore them. 

Happy Exploring the APIs :)