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

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

Before you begin

Read the following topics:

About this task

This topic describes:

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

Stopping an application on an integration server

Procedure

Stop an application.

For an independent integration server:
```
POST http://hostname:port/apiv2/applications/applicationName/stop
```
For example, to stop the application that is called HTTPInputApplication, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/stop
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.
To verify that the application has stopped, 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 stopped. 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 stopped 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/stop
```
For example, to stop the application that is called HTTPInputApplication 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/stop
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.
To verify that the application has stopped, 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 stopped. For example, to display the 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 stopped on an integration server that is managed by an integration node.

Stopping a REST API on an integration server

Procedure

Stop a REST API.

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

To verify that the REST API has stopped, 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 stopped.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/stop
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.

To verify that the REST API has stopped, 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 stopped.

Stopping an integration service on an integration server

Procedure

Stop an integration service.

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

To verify that the integration service has stopped, 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 stopped.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/stop
```
If the command is successful, an HTTP status code 200 is returned. No response message is returned.

To verify that the integration service has stopped, 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 stopped.