Updating monitoring status by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to update and persist the monitoring status for an integration server dynamically, without having to restart the integration server.

Before you begin

Read the following topics:

• Managing resources by using the administration REST API
• Monitoring by using the administration REST API

About this task

You can dynamically update monitoring status by using the PATCH verb in the administration REST API. Updates that are made by using the PATCH verb are persisted in the overrides subdirectory of the integration server's working directory, which means that the updates are not lost if the integration server is stopped.

You can use the following REST API method to update and persist the monitoring status of an integration server:

• For an independent integration server:

  PATCH http://hostname:port/apiv2/monitoring/flow-monitoring

  For example, to set monitoring status to inactive and persist this status, run the curl following command:

  curl -X PATCH http://hostname:port/apiv2/monitoring/flow-monitoring -d {"properties": { "publicationOn": "active" }}

• For an integration server that is managed by an integration node:

  PATCH http://hostname:port/apiv2/servers/integrationServerName/monitoring/flow-monitoring

  For example, to set monitoring status to inactive and persist this status on integration server ACESERV1, run the following curl command:

  curl -X PATCH http://hostname:port/apiv2/servers/ACESERV1/monitoring/flow-monitoring -d {"properties": { "publicationOn": "active" }}

  The PATCH operation updates the publicationOn setting in the Monitoring object. If the command is successful, an HTTP status code 204 is returned. You can see the updated values in the overrides subdirectory of the integration server's working directory.