Managing resources by using the administration REST API

IBM® App Connect Enterprise supports the Representational State Transfer Application Programming Interface (REST API), which you can use to administer integration nodes, integration servers, and other resources.

About this task

IBM App Connect Enterprise supports the REST API on Linux®, AIX®, and Windows platforms.

The REST API classes and methods are described in the App Connect Enterprise REST API V2 specification, which you can view in a browser by specifying the address of your integration node or integration server, and the administration REST API port, followed by /apidocs. For example, to display the REST API specification for an integration node, enter a URL as shown in the following example (specifying either http or https):
https://localhost:4414/apidocs
where localhost is the address of the integration node, and 4414 is the admin REST API port that is specified in the node.conf.yaml file.
To display the REST API specification for an integration server, enter a URL as shown in the following example (specifying either http or https):
https://green.company.com:7600/apidocs
where green.company.com is the address of the integration server, and 7600 is the admin REST API port that is specified in the server.conf.yaml file.
You can also see details of the REST API here: REST API for administering integration nodes and integration servers where:
  • openapi-appconnectenterprise.yaml details the REST API for administering integration nodes.
  • openapi-appconnectenterpriseserver.yaml details the REST API for administering integration servers.
The REST API documentation is also provided with your installation of App Connect Enterprise, in the following directories:
  • install_dir\server\nodejs\node_modules\@ibm-app-connect\ace-admin-api\docs\server
  • install_dir\server\nodejs\node_modules\@ibm-app-connect\ace-admin-api\docs\node
where install_dir is the directory in which App Connect Enterprise is installed.
For more information about how to use the administration REST API, see the following topics: