Tearing down a message flow by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to tear down named message flows that are deployed to an integration server. The message flow to tear down must already be deployed on the integration server.

Before you begin

About this task

The action of tearing down terminates all connections and threads that are associated with the message flow. The message flow remains in the runtime image of the integration server and can be restarted by using a start action without the need to redeploy. There is no need to stop and restart the integration server to restart the message flow.

This topic describes:

Tearing down a message flow in an application

About this task

You can tear down a message flow that is deployed to an integration server in an application.

Procedure

Tear down a message flow.

  • For an independent integration server: 
    POST http://hostname:port/apiv2/applications/applicationName/messageflows/messageFlowName/teardown

    For example, to tear down the message flow called RequestServiceFlow in application HTTPInputApplication, use the following curl command:

    curl -X POST http://hostname:port/apiv2/applications/HTTPInputApplication/messageflows/RequestServiceFlow/teardown

    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/teardown

    For example, to tear down the message flow called RequestServiceFlow in application HTTPInputApplication deployed to 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/RequestServiceFlow/teardown

    If the command is successful, an HTTP status code 200 and response message OK are returned.

Tearing down a message flow in a REST API project

About this task

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

Procedure

Tear down a message flow.

  • For an independent integration server: 
    POST http://hostname:port/apiv2/rest-apis/rest-apiName/messageflows/messageFlowName/teardown

    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/teardown

    If the command is successful, an HTTP status code 200 and response message OK are returned.

Tearing down a message flow in an integration service project

About this task

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

Procedure

Tear down a message flow.

  • For an independent integration server: 
    POST http://hostname:port/apiv2/services/integrationServiceName/messageflows/messageFlowName/teardown

    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 /apiv2/servers/integrationServerName/services/integrationServiceName/messageflows/messageFlowName/teardown

    If the command is successful, an HTTP status code 200 and response message OK are returned.