Starting applications, REST APIs, and integration services by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to start named applications, REST APIs, and integration services that are deployed on an integration server. The application, REST API, or integration service to be started must already be deployed in the integration server.

Before you begin

Read the following topics:

About this task

This topic describes:

Starting an application on an integration server
Starting a REST API on an integration server
Starting an integration service on an integration server

Starting an application on an integration server

Procedure

Start an application.

For an independent integration server:
```
POST http://hostname:port/apiv2/applications/applicationName/start
```
For example, to start the application that is called HTTPInputApplication, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/start
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.
To verify that the application has started, use the GET API call as described in Displaying applications, REST APIs, and integration services by using the administration REST API. Specify a value of 2 on the depth query parameter in the API call to obtain the detailed information that shows whether the application has started. For example, use the following curl command:
```
curl -X GET http://hostname:port/apiv2/applications?depth=2
```
For an example of the response that is returned for such an API call, see Check that an application has started on an independent integration server.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/applications/applicationName/start
```
For example, to start the application that is called HTTPInputApplication and deployed on integration server ACESERV1, which is managed by an integration node, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/servers/ACESERV1/applications/HTTPInputApplication/start
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.
To verify that the application has started, use the GET API call as described in Displaying applications, REST APIs, and integration services by using the administration REST API. Specify a value of 2 on the depth query parameter in the API call to obtain the detailed information that shows whether the application has started. For example, to display detailed information about applications on integration server ACESERV1, use the following curl command:
```
curl -X GET http://hostname:port/apiv2/servers/ACESERV1/applications?depth=2
```
For an example of the response that is returned for such an API call, see Check that an application has started on an integration server that is managed by an integration node.

Starting a REST API on an integration server

Procedure

Start a REST API.

For an independent integration server:
```
POST http://hostname:port/apiv2/rest-apis/rest-apiName/start
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.

To verify that the REST API has started, use the GET API call as described in Displaying applications, REST APIs, and integration services by using the administration REST API. Specify a value of 2 on the depth query parameter in the API call to obtain the detailed information that shows whether the REST API has started.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/start
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.

To verify that the REST API has started, use the GET API call as described in Displaying applications, REST APIs, and integration services by using the administration REST API. Specify a value of 2 on the depth query parameter in the API call to obtain the detailed information that shows whether the REST API has started.

Starting an integration service on an integration server

Procedure

Start an integration service.

For an independent integration server:
```
POST http://hostname:port/apiv2/services/integrationServiceName/start
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.

To verify that the integration service has started, use the GET API call as described in Displaying applications, REST APIs, and integration services by using the administration REST API. Specify a value of 2 on the depth query parameter in the API call to obtain the detailed information that shows whether the integration service has started.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/start
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.

To verify that the integration service has started, use the GET API call as described in Displaying applications, REST APIs, and integration services by using the administration REST API. Specify a value of 2 on the depth query parameter in the API call to obtain the detailed information that shows whether the integration service has started.