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

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

Before you begin

Read the following topics:

About this task

The action of tearing down terminates all connections and threads that are associated with the application, REST API, or integration service. The application, REST API, or integration service 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 application, REST API, or integration service.

This topic describes:

Tearing down an application on an integration server

Procedure

Tear down an application.

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

    For example, to tear down the application that is called HTTPInputApplication, use the following curl command:

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

    If the command is successful, an HTTP status code 200 is returned. No response message is returned.

    To verify that the tear down request has been successful, 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 information that shows whether the request was successful. 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 a teardown action has completed 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/teardown

    For example, to tear down 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/teardown

    If the command is successful, an HTTP status code 200 is returned. No response message is returned.

    To verify that the tear down request has been successful, 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 information that shows whether the request was successful. For example, use the following curl command:
    curl -X GET http://hostname:port/apiv2servers/ACESERV1/applications?depth=2
    For an example of the response that is returned for such an API call, see Check that a teardown action has completed on an integration server that is managed by an integration node.

Tearing down a REST API on an integration server

Procedure

Tear down a REST API.

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

    If the command is successful, an HTTP status code 200 is returned. No response message is returned.

    To verify that the tear down request has been successful, 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 information that shows whether the request was successful.

  • For an integration server that is managed by an integration node: 
    POST http://hostname:port/apiv2/servers/integrationServerName/rest-apis/rest-apiName/teardown

    If the command is successful, an HTTP status code 200 is returned. No response message is returned.

    To verify that the tear down request has been successful, 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 information that shows whether the request was successful.

Tearing down an integration service on an integration server

Procedure

Tear down an integration service.

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

    If the command is successful, an HTTP status code 200 is returned. No response message is returned.

    To verify that the tear down request has been successful, 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 information that shows whether the request was successful.

  • For an integration server that is managed by an integration node: 
    POST http://hostname:port/apiv2/servers/integrationServerName/services/integrationServiceName/teardown

    If the command is successful, an HTTP status code 200 is returned. No response message is returned.

    To verify that the tear down request has been successful, 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 information that shows whether the request was successful. 
    curl -X GET http://hostname:port/apiv2/servers/integrationServerName/services?depth=2