Stopping message flows by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to stop message flows that are deployed to an integration server.

Before you begin

Read the following topics:

About this task

This topic describes:

Stopping all message flows in an application
Stopping a specific message flow in an application
Stopping all message flows in a REST API project
Stopping a specific message flow in a REST API project
Stopping all message flows in an integration service project
Stopping a specific message flow in an integration service project

Stopping all message flows in an application

About this task

You can stop all the message flows that are deployed to an integration server in an application.

Procedure

Stop the message flows.

For an independent integration server:
```
POST http://hostname:port/apiv2/applications/applicationName/messageflows/stop
```
For example, to stop the message flows in application HTTPInputApplication, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/messageflows/stop
```
If the command is successful, an HTTP status code 204 is returned. No response message is returned.

If the message flows are in a library:
```
POST http://hostname:port/apiv2/applications/applicationName/libraries/libraryName/messageflows/stop 
```
For example, to stop the message flows that are in the library called HTTPStaticLib that is associated with an application called HTTPInputApplication, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/libraries/HTTPStaticLib/messageflows/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/applications/applicationName/messageflows/stop 
```
For example, to stop the message flows in application HTTPInputApplication that is 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/messageflows/stop
```
If the command is successful, an HTTP status code 204 is returned. No response message is returned.

If the message flows are in a library:
```
POST http://hostname:port/apiv2/servers/integrationServerName/applications/applicationName/libraries/libraryName/messageflows/stop
```
For example, to stop the message flows that are in the library called HTTPStaticLib associated with an application called HTTPInputApplication that is 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/libraries/HTTPStaticLib/messageflows/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.

Stopping a specific message flow in an application

About this task

You can stop a specific message flow that is deployed to an integration server in an application.

Procedure

Stop a message flow.

For an independent integration server:
```
POST http://hostname:port/apiv2/applications/applicationName/messageflows/messageFlowName/stop
```
For example, to stop a message flow called RequestServiceFlow in an application called HTTPInputApplication, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/messageflows/RequestServiceFlow/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.

If the message flow is in a library:
```
POST http://hostname:port/apiv2/applications/applicationName/libraries/libraryName/messageflows/messageFlowName/stop 
```
For example, to stop a message flow called RequestServiceFlow that is in a library called HTTPStaticLib that is associated with an application called HTTPInputApplication, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/libraries/HTTPStaticLib/messageflows/RequestServiceFlow/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/applications/applicationName/messageflows/messageFlowName/stop 
```
For example, to stop a message flow called RequestServiceFlow in application HTTPInputApplication that is deployed on integration server ACESERV1, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/servers/ACESERV1/applications/HTTPInputApplication/messageflows/RequestServiceFlow/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.

If the message flow is in a library:
```
POST http://hostname:port/apiv2/servers/integrationServerName/applications/applicationName/libraries/libraryName/messageflows/messageFlowName/stop
```
For example, to stop a message flow called RequestServiceFlow that is in a library called HTTPStaticLib associated with an application called HTTPInputApplication that is deployed on integration server ACESERV1, use the following curl command:
```
curl -X POST http://hostname:port/apiv2/servers/ACESERV1/applications/HTTPInputApplication/libraries/HTTPStaticLib/messageflows/RequestServiceFlow/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.

Stopping all message flows in a REST API project

About this task

You can stop all the message flows that are deployed to an integration server in a REST API project.

Procedure

Stop the message flows.

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

If the message flows are in a library:
```
POST http://hostname:port/apiv2//rest-apis/rest-apiName/libraries/libraryName/messageflows/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/messageflows/stop 
```
If the command is successful, an HTTP status code 204 is returned. No response message is returned.

If the message flows are in a library:
```
POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/libraries/libraryName/messageflows/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.

Stopping a specific message flow in a REST API project

About this task

You can stop a specific message flow that is deployed to an integration server in a REST API project.

Procedure

Stop a message flow.

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

If the message flow is in a library:
```
POST http://hostname:port/apiv2/rest-apis/rest-apiName/libraries/libraryName/messageflows/messageFlowName/stop 
```
If the command is successful, an HTTP status code 200 and response message OK are returned.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/messageflows/messageFlowName/stop 
```
If the command is successful, an HTTP status code 204 is returned. No response message is returned.

If the message flow is in a library:
```
POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/libraries/libraryName/messageflows/messageFlowName/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.

Stopping all message flows in an integration service project

About this task

You can stop all the message flows that are deployed to an integration server in an integration service project.

Procedure

Stop the message flows.

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

If the message flows are in a library:
```
POST http://hostname:port/apiv2/services/integrationServiceName/libraries/libraryName/messageflows/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/messageflows/stop 
```
If the command is successful, an HTTP status code 204 is returned. No response message is returned.

If the message flows are in a library:
```
POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/libraries/libraryName/messageflows/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.

Stopping a specific message flow in an integration service project

About this task

You can stop a specific message flow that is deployed to an integration server in an integration service project.

Procedure

Stop the message flow.

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

If the message flow is in a library:
```
POST http://hostname:port/apiv2/services/integrationServiceName/libraries/libraryName/messageflows/messageFlowName/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.
For an integration server that is managed by an integration node:
```
POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/messageflows/messageFlowName/stop 
```
If the command is successful, an HTTP status code 204 is returned. No response message is returned.

If the message flow is in a library:
```
POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/libraries/libraryName/messageflows/messageFlowName/stop
```
If the command is successful, an HTTP status code 200 and response message OK are returned.