Status

Display current status for the system.

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

Request

Parameters

command	status
format	properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc. json - Useful format for parsing into javascript or other languages. See www.json.org for details.

Headers

Accept	application/json
Content-Type	application/json

Response

Parameters

type	Executed command name
DB-TEMP-total-space	???
date	Date of the status check
son-status	Status of System Operations Node (SON)
maintenance-mode	Indicates if the server is in maintenance mode
DB-TEMP-free-space	???
database-status	The status of database used by the system.
product-version	Information on current product version with patch / hotfix
local-afx-status	The status of local AFX server (if configured).
DB-TEMP-used-space	???
root-logger-level	The root logger level. Possible values : OFF FATAL ERROR WARN INFO DEBUG TRACE ALL
email-server-status	The status of email server in the system(if configured).
overall-status	???
jms-status	The status of JMS module in the system.
default-agent-status	The status of default agent used by the system.

Examples

Request

Curl

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

Python

import requests, json

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

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

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
}

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>',
    'Content-Type': 'application/json'
};

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

{
    "data": {
        "type": "status",
        "DB-TEMP-total-space": "571",
        "date": "2023-08-27 16:58:23",
        "son-status": "HEALTHY",
        "maintenance-mode": "off",
        "DB-TEMP-free-space": "552",
        "database-status": "HEALTHY",
        "product-version": "7.5.2.184537 P07_HF02",
        "local-afx-status": "HEALTHY",
        "DB-TEMP-used-space": "19",
        "root-logger-level": "INFO",
        "email-server-status": "UNHEALTHY",
        "overall-status": "HEALTHY",
        "jms-status": "HEALTHY",
        "default-agent-status": "UNHEALTHY"
    }
}