Displaying integration servers by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to display the properties of managed integration servers.

Before you begin

Read the following topics:

Procedure

Display the properties of an integration server:

GET http://hostname:port/apiv2/servers/integrationServerName

For example, to display the properties of integration server ACESERV1, run the following curl command:

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

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

{
    "hasChildren": true,
    "name": "ACESERV1",
    "type": "integrationServer",
    "uri": "/apiv2/servers/ACESERV1",
    "properties": {
        "brokerDefaultCCSID": "5348",
        "dataSourceName": "",
        "dataSourcePassword": "********",
        "dataSourceUserId": "LocalSystem",
        "defaultConfigurationTimeout": 300,
        "defaultQueueManager": "",
        "forceServerHTTPS": false,
        "jvmDebugPort": 0,
        "jvmMaxHeapSize": 268435456,
        "jvmMinHeapSize": 33554432,
        "lilPath": "",
        "mqTrustedQueueManager": "no",
        "name": "ACESERV1",
        "stopIfDefaultQMUnavailable": false,
        "trace": "none",
        "traceNodeLevel": true,
        "traceSize": "1G",
        "type": "IntegrationServer"
    },
    "descriptiveProperties": {
        "buildLevel": "ib000-L200318.17215 (S000-L200318.16524)",
        "platformArchitecture": "AMD64",
        "platformName": "Windows 10 Enterprise",
        "platformVersion": "6.3 build 19041 ",
        "productName": "IBM App Connect Enterprise",
        "version": "11.0.0.8"
    },
    "active": {
        "defaultApplicationName": "ACESERV1_DefaultApplication",
        "exceptionLoggingOn": false,
        "isRunning": true,
        "lastMessageEpoch": 0,
        "lastMessageTime": "1970-01-01T00:00:00Z",
        "monitoring": "inactive",
        "monitoringProfile": "",
        "processId": 24096,
        "serviceTraceOn": false,
        "startupEpoch": 1604864621,
        "startupTime": "2020-11-08T19:43:41Z",
        "state": "started",
        "userTraceOn": false
    },
    
    "links": []
}

Additionally, you can use the depth query parameter in the API call to obtain information about more properties of the integration server. For example, use the following curl command:

curl -X GET http://hostname:port/apiv2/servers/ACESERV1?depth=2

Display the properties of all managed integration servers:

GET http://hostname:port/apiv2/servers

For example, run the following curl command:

curl -X GET http://hostname:port/apiv2/servers

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

{
    "type": "integrationServers",
    "children": [
        {
            "name": "ACESERV1",
            "hasChildren": true,
            "uri": "/apiv2/servers/ACESERV1",
            "type": "integrationServer",
            "active": {
                "processId": 22920,
                "isRunning": true,
                "state": "started"
            }
        },
        {
            "name": "ACESERV2",
            "hasChildren": true,
            "uri": "/apiv2/servers/ACESERV2",
            "type": "integrationServer",
            "active": {
                "processId": 24536,
                "isRunning": true,
                "state": "started"
            }
        }
    ]
}

Additionally, you can use the depth query parameter in the API call to obtain information about more properties of the integration server. For example, use the following curl command:

curl -X GET http://hostname:port/apiv2/servers?depth=2