Retrieve server information

Use this resource to retrieve information about the server. The response includes details such as the Process Engine version, the used JDK version, and the operating system name. This information corresponds to the data displayed in the Workbench on the Server information tab.

Request

To retrieve the server information, send a GET request to the endpoint defined below.

URL: /system/info

Method: GET

Authorization: required

GET /ibis/rest/system/info HTTP/1.1
Accept: application/xml
Host: localhost:8080

Request Parameters

The following table lists the parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`user`	Enter the username of the Process Engine user. This parameter is only required for cluster instances to receive the active node count in the response.	no	Username (Process Engine)

user

Enter the username of the Process Engine user. This parameter is only required for cluster instances to receive the active node count in the response.

Username (Process Engine)

Response

The response contains the requested server information in XML format.

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SystemInformationList xmlns="inubit.com/ibis/external/systeminformation">
    <SystemInformation name="Version" value="7.4.0.61"/>
    <SystemInformation name="FreeMemory" value="568"/>
    <SystemInformation name="ActiveNodesCount" value="1"/>
    <SystemInformation name="ServerOSArch" value="64"/>
    <SystemInformation name="TracingIsActive" value="true"/>
    <SystemInformation name="TracingLevel" value="debug"/>
    <SystemInformation name="NumberSchedulerThreads" value="10"/>
    <SystemInformation name="ServerOSName" value="Linux"/>
    <SystemInformation name="ServerOSVersion" value="5.4.0-81-generic"/>
    <SystemInformation name="ServerJDKVersion" value="11.0.12 - 64 bit"/>
    <SystemInformation name="ServerJDKVendor" value="Eclipse Foundation"/>
    <SystemInformation name="SchedulerThreadsPriority" value="5"/>
    <SystemInformation name="ServerJDKName" value="OpenJDK Runtime Environment"/>
    <SystemInformation name="ServerXMX" value="4096"/>
    <SystemInformation name="ServerJDKSpec" value="11"/>
</SystemInformationList>

Errors

This request might return one of the following error codes:

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.