APIs for System Console

Owned by Akash Kumar Jaiswal (Unlicensed)
Last updated: Aug 28, 2020Version comment
4 min read

You can use APIs to view the status of various sections of System Console without visiting Adeptia Connect.

Use any REST client with the following information as an input to process your request.

Component

Information type

REST URL

Refer to the URLs described later in this section for various sections of System Console. Replace <ipaddress/domain>:<port> with the relevant values in the URL.

IP Address, Domain, and Port address should be of the computer where Adeptia Connect is hosted.

Method TypeGET
Authorization TypeBasic 
HeaderAuthorization
User ID & PasswordAdministrator or Group Administrator User ID and Password for Base 64 encoding.

 

APIs

Click the relevant section to find API and expected response format.

 

 License Status
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=license

Response

{

"license": [3]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "Valid till Dec 11, 2025"
}
-1:  
{
"name": "Product Version"
"value": "6.3"
}
-2:  
{
"name": "Build Tag"
"value": "Version_6_5_01_29Aug_2016"
}
}
 Cluster Status
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=cluster
Response

{

"cluster": [2]-0:  
{
"name": "Status"
"value": "Enabled"
}
-1:  
{
"display-type": "table"
"name": "Nodes Information""value": [2]-0:  
{
"Name": "10.0.0.169"
"Status": "UP"
"Type": "Secondary"
}
-1:  
{
"Name": "10.0.0.85"
"Status": "UP"
"Type": "Primary"
}
}
}
 Scheduler Status
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=scheduler
Response

{

"scheduler": [6]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "Running"
}
-1:  
{
"name": "Thread Count"
"value": "50"
}
-2:  
{
"name": "Thread Priority"
"value": "5"
}
-3:  
{
"name": "Misfire Threshold"
"value": "60000 miliseconds"
}
-4:  
{
"name": "Total Active Events"
"value": "40"
}
-5:  
{
"name": "Misfired Events in Last 24 Hours"
"warning-message": "63 events have misfired. This may lead to loss of data while processing. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to know how to handle misfired events."
"value": "63"
"threshold-crossed": true
}
}
 Backend Database Status
API https:/<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=backend-database
Response

{

"backend-database": [2]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
}
 Log Database Status
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=log-database
Repsonse

{

"log-database": 
[10]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
-2:  
{
"name": "Process Flow Logs"
"value": "713305 Records"
}
-3:  
{
"name": "Event Logs"
"value": "102468 Records"
}
-4:  
{
"name": "System Logs"
"value": "36066 Records"
}
-5:  
{
"name": "Audit Trail"
"value": "5156 Records"
}
-6:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-7:  
{
"name": "Log Cleanup Status"
"value": " "
}
-8:  
{
"name": "Log Cleanup Execution Time"
"value": " "
}
-9:  
{
"name": "Next Scheduled Execution Time of Log Cleanup"
"value": "12/28/2017 03:00:00"
}
}
 Process Execution Status
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=process-execution
Response

{

"process-execution": [10]-0:  
{
"color": "#00cc00"
"name": "Queue Processor Status"
"value": "Enabled"
}
-1:  
{
"name": "Concurrent Process Flow Execution Limit"
"value": 5
}
-2:  
{
"name": "Running Process Flows"
"value": "0"
}
-3:  
{
"name": "Waiting Process Flows"
"value": "0"
}
-4:  
{
"name": "Queued Process Flows"
"value": "0"
}
-5:  
{
"name": "Total Active Process Flow"
"value": 36
}
-6:  
{
"name": "Logging Level"
"warning-message": "In production, the Logging Level should be set as ERROR for better performance."
"value": "ERROR: 27, INFO: 7, DEBUG: 2"
}
-7:  
{
"name": "Activity Logging Retention"
"warning-message": "In production, the Activity Logging Retention field should be set as NO LOGGING for better performance."
"value": "NO LOGGING: 0, DELETE ON SUCCESS: 25, DONT DELETE: 11"
}
-8:  
{
"name": "Repository Retention"
"warning-message": "In production, the Repository File Retention field should be set as DELETE for better performance."
"value": "DELETE: 0, DELETE ON SUCCESS: 3, DONT DELETE: 33"
}
-9:  
{
"name": "JDO Cache"
"value": "Enabled"
}
}
 Archive Log Database Status
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=archive-log-database
Response

{

"archive-log-database": [8]-0:  
{
"name": "Separate from Log Database"
"value": "No"
}
-1:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-2:  
{
"name": "Type"
"value": "MySQL"
}
-3:  
{
"name": "Process Flow Logs"
"value": "1018 Records"
}
-4:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-5:  
{
"name": "Archival Log Cleanup Status"
"value": " "
}
-6:  
{
"name": "Archival Log Cleanup Execution Time"
"value": " "
}
-7:  
{
"name": "Next Scheduled Execution Time of Archival Log Cleanup "
"value": "12/28/2017 03:00:00"
}
}
 System Information
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=system-info&nodeName=<nodename>
Response

{

"system-info": [7]-0:  
{
"name": "CPU"
"used": 0
"total": 100
"used-percentage": 0
"display-type": "graph"
}
-1:  
{
"name": "RAM"
"total": "7.8 GB"
"used": "7.2 GB"
"used-percentage": 91
"threshold-crossed": true
"warning-message": "Multiple processes involved resulting in low memory. <a href="https://docs.adeptia.com/display/AS/Troubleshooting"target="_blank">Click here</a> to troubleshoot."
"display-type": "graph"
}
-2:  
{
"name": "Disk"
"used": "12.4 GB"
"total": "49.1 GB"
"used-percentage": 25
"display-type": "graph"
}
-3:  
{
"name": "Operating System"
"value": "Linux Version 4.4.8-20.46.amzn1.x86_64"
}
-4:  
{
"name": "Processor Architecture"
"value": "amd64"
}
-5:  
{
"name": "Processor"
"value": "Intel(R) Xeon(R) CPU E5-2676 v3 @ 2.40GHz"
}
-6:  
{
"name": "Number Of Processors"
"value": "2"
}
}
 Kernel Information
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=kernel&nodeName=<nodename>
Response

{

"kernel": [9]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "ON"
}
-1:  
{
"name": "Start Time"
"value": "August 29, 2016 11:47:43 UTC"
}
-2:  
{
"name": "Up Time"
"value": "17 hour(s) 33 min(s) 17 sec(s)"
}
-3:  
{
"name": "Used Memory"
"used": "527.176 MB"
"total": "1764.5 MB"
"used-percentage": 29
"display-type": "graph"
}
-4:  
{
"name": "Live Thread Count"
"value": "150"
}
-5:  
{
"name": "Deadlock Thread Count"
"value": "0"
}
-6:  
{
"total": 50
"display-type": "graph"
"name": "Backend Database Connection Pool"
"used": 0
}
-7:  
{
"total": 100
"display-type": "graph"
"name": "Log Database Connection Pool"
"used": 0
}
-8:  
{
"display-type": "table"
"name": "Garbage Collection Information""value":[2]-0:  
{
"Name": "PS Scavenge"
"Number Of Collections": 27
"Total Time Spent": "0.118 min"
}
-1:  
{
"Name": "PS MarkSweep"
"Number Of Collections": 19
"Total Time Spent": "0.093 min"
}
}
}
 WebRunner Information
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=webRunner&nodeName=<nodename>
Response

{

"webRunner": [9]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "ON"
}
-1:  
{
"name": "Start Time"
"value": "August 29, 2016 11:47:45 UTC"
}
-2:  
{
"name": "Up Time"
"value": "17 hour(s) 35 min(s) 6 sec(s)"
}
-3:  
{
"name": "Used Memory"
"used": "997.072 MB"
"total": "1362.0 MB"
"used-percentage": 73
"display-type": "graph"
}
-4:  
{
"name": "Live Thread Count"
"value": "69"
}
-5:  
{
"name": "Deadlock Thread Count"
"value": "0"
}
-6:  
{
"total": 25
"display-type": "graph"
"name": "Backend Database Connection Pool"
"used": 0
}
-7:  
{
"total": 25
"display-type": "graph"
"name": "Log Database Connection Pool"
"used": 0
}
-8:  
{
"display-type": "table"
"name": "Garbage Collection Information""value": [2]-0:  
{
"Name": "PS Scavenge"
"Number Of Collections": 40
"Total Time Spent": "0.106 min"
}
-1:  
{
"Name": "PS MarkSweep"
"Number Of Collections": 21
"Total Time Spent": "0.134 min"
}
}
}
 Status of All Sections of System Console
APIhttps://<ipaddress/domain>:<port>/adeptia/rest/diagnostics?component=all
Response

{

"license": [3]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "Valid till Dec 11, 2025"
}
-1:  
{
"name": "Product Version"
"value": "6.3"
}
-2:  
{
"name": "Build Tag"
"value": "Version_6_5_01_29Aug_2016"
}
-"backend-database": [2]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
-"cluster": [2]-0:  
{
"name": "Status"
"value": "Enabled"
}
-1:  
{
"display-type": "table"
"name": "Nodes Information""value":[2]-0:  
{
"Name": "10.0.0.169"
"Status": "UP"
"Type": "Secondary"
}
-1:  
{
"Name": "10.0.0.85"
"Status": "UP"
"Type": "Primary"
}
}
-"scheduler": [6]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "Running"
}
-1:  
{
"name": "Thread Count"
"value": "50"
}
-2:  
{
"name": "Thread Priority"
"value": "5"
}
-3:  
{
"name": "Misfire Threshold"
"value": "60000 miliseconds"
}
-4:  
{
"name": "Total Active Events"
"value": "38"
}
-5:  
{
"name": "Misfired Events in Last 24 Hours"
"warning-message": "64 events have misfired. This may lead to loss of data while processing. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to know how to handle misfired events."
"value": "64"
"threshold-crossed": true
}
-"process-execution": [10]-0:  
{
"color": "#00cc00"
"name": "Queue Processor Status"
"value": "Enabled"
}
-1:  
{
"name": "Concurrent Process Flow Execution Limit"
"value": 5
}
-2:  
{
"name": "Running Process Flows"
"value": "0"
}
-3:  
{
"name": "Waiting Process Flows"
"value": "0"
}
-4:  
{
"name": "Queued Process Flows"
"value": "0"
}
-5:  
{
"name": "Total Active Process Flow"
"value": 36
}
-6:  
{
"name": "Logging Level"
"warning-message": "In production, the Logging Level should be set as ERROR for better performance."
"value": "ERROR: 27, INFO: 7, DEBUG: 2"
}
-7:  
{
"name": "Activity Logging Retention"
"warning-message": "In production, the Activity Logging Retention field should be set as NO LOGGING for better performance."
"value": "NO LOGGING: 0, DELETE ON SUCCESS: 25, DONT DELETE: 11"
}
-8:  
{
"name": "Repository Retention"
"warning-message": "In production, the Repository File Retention field should be set as DELETE for better performance."
"value": "DELETE: 0, DELETE ON SUCCESS: 3, DONT DELETE: 33"
}
-9:  
{
"name": "JDO Cache"
"value": "Enabled"
}
-"log-database":[10]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
-2:  
{
"name": "Process Flow Logs"
"value": "713312 Records"
}
-3:  
{
"name": "Event Logs"
"value": "102478 Records"
}
-4:  
{
"name": "System Logs"
"value": "36082 Records"
}
-5:  
{
"name": "Audit Trail"
"value": "5165 Records"
}
-6:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-7:  
{
"name": "Log Cleanup Status"
"value": " "
}
-8:  
{
"name": "Log Cleanup Execution Time"
"value": " "
}
-9:  
{
"name": "Next Scheduled Execution Time of Log Cleanup"
"value": "12/28/2017 03:00:00"
}
-"archive-log-database": [8]-0:  
{
"name": "Separate from Log Database"
"value": "No"
}
-1:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-2:  
{
"name": "Type"
"value": "MySQL"
}
-3:  
{
"name": "Process Flow Logs"
"value": "1018 Records"
}
-4:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-5:  
{
"name": "Archival Log Cleanup Status"
"value": " "
}
-6:  
{
"name": "Archival Log Cleanup Execution Time"
"value": " "
}
-7:  
{
"name": "Next Scheduled Execution Time of Archival Log Cleanup "
"value": "12/28/2017 03:00:00"
}
-"node": [1]-0:  
{"10.0.0.169": 
{"system-info":[7]-0:  
{
"name": "CPU"
"used": 0
"total": 100
"used-percentage": 0
"display-type": "graph"
}
-1:  
{
"name": "RAM"
"total": "7.8 GB"
"used": "7.2 GB"
"used-percentage": 91
"threshold-crossed": true
"warning-message": "Multiple processes involved resulting in low memory. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to troubleshoot."
"display-type": "graph"
}
-2:  
{
"name": "Disk"
"used": "12.4 GB"
"total": "49.1 GB"
"used-percentage": 25
"display-type": "graph"
}
-3:  
{
"name": "Operating System"
"value": "Linux Version 4.4.8-20.46.amzn1.x86_64"
}
-4:  
{
"name": "Processor Architecture"
"value": "amd64"
}
-5:  
{
"name": "Processor"
"value": "Intel(R) Xeon(R) CPU E5-2676 v3 @ 2.40GHz"
}
-6:  
{
"name": "Number Of Processors"
"value": "2"
}
-"kernel":[9]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "ON"
}
-1:  
{
"name": "Start Time"
"value": "August 29, 2016 11:47:43 UTC"
}
-2:  
{
"name": "Up Time"
"value": "17 hour(s) 36 min(s) 37 sec(s)"
}
-3:  
{
"name": "Used Memory"
"used": "551.002 MB"
"total": "1764.5 MB"
"used-percentage": 31
"display-type": "graph"
}
-4:  
{
"name": "Live Thread Count"
"value": "151"
}
-5:  
{
"name": "Deadlock Thread Count"
"value": "0"
}
-6:  
{
"total": 50
"display-type": "graph"
"name": "Backend Database Connection Pool"
"used": 0
}
-7:  
{
"total": 100
"display-type": "graph"
"name": "Log Database Connection Pool"
"used": 0
}
-8:  
{
"display-type": "table"
"name": "Garbage Collection Information""value": [2]-0:  
{
"Name": "PS Scavenge"
"Number Of Collections": 27
"Total Time Spent": "0.118 min"
}
-1:  
{
"Name": "PS MarkSweep"
"Number Of Collections": 19
"Total Time Spent": "0.093 min"
}
}
-"webRunner": [9]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "ON"
}
-1:  
{
"name": "Start Time"
"value": "August 29, 2016 11:47:45 UTC"
}
-2:  
{
"name": "Up Time"
"value": "17 hour(s) 36 min(s) 35 sec(s)"
}
-3:  
{
"name": "Used Memory"
"used": "109.449 MB"
"total": "1368.5 MB"
"used-percentage": 7
"display-type": "graph"
}
-4:  
{
"name": "Live Thread Count"
"value": "71"
}
-5:  
{
"name": "Deadlock Thread Count"
"value": "0"
}
-6:  
{
"total": 25
"display-type": "graph"
"name": "Backend Database Connection Pool"
"used": 0
}
-7:  
{
"total": 25
"display-type": "graph"
"name": "Log Database Connection Pool"
"used": 0
}
-8:  
{
"display-type": "table"
"name": "Garbage Collection Information""value": [2]-0:  
{
"Name": "PS Scavenge"
"Number Of Collections": 41
"Total Time Spent": "0.106 min"
}
-1:  
{
"Name": "PS MarkSweep"
"Number Of Collections": 21
"Total Time Spent": "0.134 min"
}
}
}
-"10.0.0.85": 
{"system-info": [7]-0:  
{
"name": "CPU"
"used": 0
"total": 100
"used-percentage": 0
"display-type": "graph"
}
-1:  
{
"name": "RAM"
"total": "7.8 GB"
"used": "7.7 GB"
"used-percentage": 98
"threshold-crossed": true
"warning-message": "Multiple processes involved resulting in low memory. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to troubleshoot."
"display-type": "graph"
}
-2:  
{
"name": "Disk"
"used": "17.1 GB"
"total": "29.4 GB"
"used-percentage": 58
"display-type": "graph"
}
-3:  
{
"name": "Operating System"
"value": "Linux Version 4.4.8-20.46.amzn1.x86_64"
}
-4:  
{
"name": "Processor Architecture"
"value": "amd64"
}
-5:  
{
"name": "Processor"
"value": "Intel(R) Xeon(R) CPU E5-2676 v3 @ 2.40GHz"
}
-6:  
{
"name": "Number Of Processors"
"value": "2"
}
-"kernel": [9]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "ON"
}
-1:  
{
"name": "Start Time"
"value": "August 29, 2016 11:46:04 UTC"
}
-2:  
{
"name": "Up Time"
"value": "17 hour(s) 38 min(s) 17 sec(s)"
}
-3:  
{
"name": "Used Memory"
"used": "159.626 MB"
"total": "1603.0 MB"
"used-percentage": 9
"display-type": "graph"
}
-4:  
{
"name": "Live Thread Count"
"value": "159"
}
-5:  
{
"name": "Deadlock Thread Count"
"value": "0"
}
-6:  
{
"total": 50
"display-type": "graph"
"name": "Backend Database Connection Pool"
"used": 0
}
-7:  
{
"total": 100
"display-type": "graph"
"name": "Log Database Connection Pool"
"used": 0
}
-8:  
{
"display-type": "table"
"name": "Garbage Collection Information""value": [2]-0:  
{
"Name": "PS Scavenge"
"Number Of Collections": 105
"Total Time Spent": "0.143 min"
}
-1:  
{
"Name": "PS MarkSweep"
"Number Of Collections": 20
"Total Time Spent": "0.124 min"
}
}
-"webRunner": [9]-0:  
{
"color": "#00cc00"
"name": "Status"
"value": "ON"
}
-1:  
{
"name": "Start Time"
"value": "August 29, 2016 11:46:06 UTC"
}
-2:  
{
"name": "Up Time"
"value": "17 hour(s) 38 min(s) 15 sec(s)"
}
-3:  
{
"name": "Used Memory"
"used": "304.375 MB"
"total": "803.5 MB"
"used-percentage": 37
"display-type": "graph"
}
-4:  
{
"name": "Live Thread Count"
"value": "72"
}
-5:  
{
"name": "Deadlock Thread Count"
"value": "0"
}
-6:  
{
"total": 25
"display-type": "graph"
"name": "Backend Database Connection Pool"
"used": 0
}
-7:  
{
"total": 25
"display-type": "graph"
"name": "Log Database Connection Pool"
"used": 0
}
-8:  
{
"display-type": "table"
"name": "Garbage Collection Information""value": [2]-0:  
{
"Name": "PS Scavenge"
"Number Of Collections": 150
"Total Time Spent": "0.152 min"
}
-1:  
{
"Name": "PS MarkSweep"
"Number Of Collections": 24
"Total Time Spent": "0.171 min"
}
}
}
}
}


 

You may be interested in...
What's new
Best practices
Training guides
Frequently asked questions
Adeptia Connect APIs
Adeptia security report