Displaying monitoring status by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to display the monitoring status for an integration server.

• For an independent integration server:

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

  For example, run the following curl command:

  curl -X GET http://localhost:port/apiv2/monitoring/flow-monitoring

  If the command is successful, an HTTP status code 200 and a response similar to the following are returned:

  {
      "hasChildren": false,
      "name": "flow-monitoring",
      "type": "flowMonitoring",
      "uri": "/apiv2/monitoring/flow-monitoring",
      "properties": {
          "eventFormat": "MonitoringEventV2",
          "name": "MessageFlow",
          "publicationOn": "active",
          "type": "MessageFlow",
          "useParserNameInPayload": false
      },
      "descriptiveProperties": {},
      "active": {
          "publicationOn": "active"
      },
      "actions": {
          "unavailable": {
              "start-monitoring": "/apiv2/monitoring/flow-monitoring/start-monitoring"
          },
          "available": {
              "stop-monitoring": "/apiv2/monitoring/flow-monitoring/stop-monitoring"
          }
      },
      "children": {},
      "links": []
  }
  

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

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

  For example, to display the monitoring status for integration server ACESERV1, run the following command:

  curl -X GET http://hostname:port/apiv2/servers/ACESERV1/monitoring/flow-monitoring

  If the command is successful, an HTTP status code 200 and a response similar to the following are returned:

  {
      "hasChildren": false,
      "name": "flow-monitoring",
      "type": "flowMonitoring",
      "uri": "/apiv2/servers/ACESERV1/monitoring/flow-monitoring",
      "properties": {
          "eventFormat": "MonitoringEventV2",
          "name": "MessageFlow",
          "publicationOn": "active",
          "type": "MessageFlow",
          "useParserNameInPayload": false
      },
      "descriptiveProperties": {},
      "active": {
          "publicationOn": "active"
      },
      "actions": {
          "unavailable": {
              "start-monitoring": "/apiv2/servers/ACESERV1/monitoring/flow-monitoring/start-monitoring"
          },
          "available": {
              "stop-monitoring": "/apiv2/servers/ACESERV1/monitoring/flow-monitoring/stop-monitoring"
          }
      },
      "children": {},
      "links": []
  }