Status

Display the current operational status of the system.

GET https://instance.securid.com/aveksa/command.submit?cmd=status

Request

Parameters

command	status
format	properties - (Default) Returns the response as key=value pairs. json - Returns the response as JSON.

Headers

Authorization	Bearer token
Accept	application/json
Content-Type	application/json

Response

Parameters

overall-status	The overall status of the system.
jms-status	The status of the JMS module.
email-server-status	The status of the email server (if configured).
default-agent-status	The status of the default agent.
database-status	The status of the database.
local-afx-status	The status of the local AFX server (if configured).
son-status	The status of the System Operations Node (SON).
host-status	The status of the host. Returns NA if not applicable.
maintenance-mode	Whether the server is in maintenance mode. Values: on off
product-version	The server build number.
date	The date and time of the status check.
root-logger-level	The current log level. Values: OFF FATAL ERROR WARN INFO DEBUG TRACE ALL
server-up-time	Server uptime in seconds.
no-of-unhealthy-nodes	Number of unhealthy cluster nodes.
write-applogs-to-db	Whether application logs are written to the database. Values: on off
DB-TEMP-total-space	Total temporary database space in MB.
DB-TEMP-used-space	Used temporary database space in MB.
DB-TEMP-free-space	Free temporary database space in MB.
status_monitoring.cumulative-admin-error	Total admin errors since the last server restart.
status_monitoring.count-of-admin-error-daily	Admin errors in the current day.
status_monitoring.afx-status	AFX server health summary.
status_monitoring.reviews-past-due	Number of reviews past their due date.
status_monitoring.review-end-date	Number of reviews approaching their end date.
status_monitoring.open-cr	Number of open change requests.
status_monitoring.open-watches	Number of open watches.
status_monitoring.user-session	Number of active user sessions.
status_monitoring.user_count	Total number of users in the system.
status_monitoring.workflow-errors	Number of workflow errors.
status_monitoring.collection-failure	Cumulative number of collection failures.
status_monitoring.collection-failure_realtime	Collection failures in the current monitoring window.
status_monitoring.current_collections	Number of collections currently running.
status_monitoring.collections-running-more-than-30-mins	Number of collections running longer than 30 minutes.
status_monitoring.collections-running-more-than-1-hour	Number of collections running longer than 1 hour.
status_monitoring.collectors-in-queue	Number of collectors currently in the run queue.
status_monitoring.countOfCollectorsAbove95thpercentile	Number of collectors above the 95th percentile for run time.
status_monitoring.remote_afx_down15min_count	Number of remote AFX servers that have been down for 15 minutes or more.
status_monitoring.last_successful_purge	Days since the last successful purge job.
status_monitoring.invalid_custom_objects	Number of invalid custom objects detected.
status_monitoring.size-of-source-table	Source table size in GB.
status_monitoring.size-of-source-table-GB	Source table size in GB (same value as size-of-source-table).

Examples

Request

Curl

curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=status&format=json" \
-H "Authorization: Bearer <token>"

Python

import requests

url = "https://instance.securid.com/aveksa/command.submit"

params = {
    "cmd": "status",
    "format": "json"
}

headers = {
    'Authorization': 'Bearer <token>'
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Request failed with status code {response.status_code}")

Node.js

const axios = require('axios');

const url = "https://instance.securid.com/aveksa/command.submit";

const params = {
    cmd: "status",
    format: "json"
};

const headers = {
    'Authorization': 'Bearer <token>'
};

axios.get(url, { params, headers })
    .then(response => {
        if (response.status === 200) {
            console.log(response.data);
        } else {
            console.log(`Request failed with status code ${response.status}`);
        }
    })
    .catch(error => {
        console.error('Error:', error);
    });

Response

200 (JSON)

{
    "data": {
        "type": "status",
        "overall-status": "HEALTHY",
        "jms-status": "HEALTHY",
        "email-server-status": "HEALTHY",
        "default-agent-status": "UNHEALTHY",
        "database-status": "HEALTHY",
        "local-afx-status": "HEALTHY",
        "son-status": "HEALTHY",
        "host-status": "NA",
        "maintenance-mode": "off",
        "product-version": "188886",
        "date": "2026-01-15 10:00:00",
        "root-logger-level": "INFO",
        "server-up-time": "8607",
        "no-of-unhealthy-nodes": "0",
        "write-applogs-to-db": "on",
        "DB-TEMP-total-space": "34767",
        "DB-TEMP-used-space": "5",
        "DB-TEMP-free-space": "34762",
        "status_monitoring.cumulative-admin-error": "0",
        "status_monitoring.count-of-admin-error-daily": "0",
        "status_monitoring.afx-status": "1.Green - AFX Server",
        "status_monitoring.reviews-past-due": "0",
        "status_monitoring.review-end-date": "0",
        "status_monitoring.open-cr": "0",
        "status_monitoring.open-watches": "0",
        "status_monitoring.user-session": "1",
        "status_monitoring.user_count": "50",
        "status_monitoring.workflow-errors": "0",
        "status_monitoring.collection-failure": "0",
        "status_monitoring.collection-failure_realtime": "0",
        "status_monitoring.current_collections": "0",
        "status_monitoring.collections-running-more-than-30-mins": "0",
        "status_monitoring.collections-running-more-than-1-hour": "0",
        "status_monitoring.collectors-in-queue": "0",
        "status_monitoring.countOfCollectorsAbove95thpercentile": "0",
        "status_monitoring.remote_afx_down15min_count": "0",
        "status_monitoring.last_successful_purge": "1",
        "status_monitoring.invalid_custom_objects": "0",
        "status_monitoring.size-of-source-table": "0.68",
        "status_monitoring.size-of-source-table-GB": "0.68"
    }
}

200 (Properties)

Default format when format is omitted.

overall-status=HEALTHY
jms-status=HEALTHY
email-server-status=HEALTHY
default-agent-status=UNHEALTHY
database-status=HEALTHY
local-afx-status=HEALTHY
son-status=HEALTHY
maintenance-mode=off
product-version=188886
date=2026-01-15 10:00:00
root-logger-level=INFO
server-up-time=8607
...

401 Invalid Token

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The token is not valid for the command 'status'. Token is invalid or expired</body>
</html>

Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.