Knowledge Base

get_system_status

Get system status - healthcheck information

No parameters.

New from version 10.3: "severity" value returned to indicate impact of failures or warnings which can be helpful for system monitoring.

0 represents a critical failure which in most cases will prevent operation of the system. These require immediate attention.
1 represents a warning where functionality may not work correctly or system administrator action is encouraged to prevent a critical failure.
2 represents a notice that can help with ensuring optimal performance.

Note: Not all checks provide a "severity" value so it may not always be returned in the output.

The available status values have also been simplified to either 'Ok' or Fail'.

Return values

Returns back system status information (configuration dependant - e.g mysql_log_transactions).

{
    "results": {
        "quota_limit": {
            "status": "OK",
            "info": "1% used.",
            "avail": 10000000000,
            "used": "1140631",
            "percent": 1
        },
        "version": {
            "status": "OK",
            "info": "SVN Trunk"
        },
        "svn": {
            "status": "OK",
            "info": " r18225:18234"
        },
        "plugins": {
            "status": "OK",
            "info": "rse_search_notifications, rse_version, rse_workflow, multicrop, transform, consentmanager, format_chooser, licensemanager, lightbox_preview"
        },
        "recent_user_count": {
            "status": "OK",
            "info": "12"
        }
    },
    "status": "OK"
}

Example when something is wrong:

{
    "results": {
        "cron_process": {
            "status": "FAIL",
            "info": "Cron was executed 26 days ago."
        }
    },
    "status": "FAIL"
}