The SQL DM for MySQL API allows users to retrieve monitor and chart values programmatically. The API supports fetching current, delta, and historical data.

Base URL

http://127.0.0.1:5555/

Authentication

All API requests need authentication using the following parameters:

• _user: It may be sqldm user, LDAP user or LDAP Group user. In case no user is supplied, admin account is used by default.
• _password: The password for the specified _user.

API Endpoints

Get All Monitors ValuesGet Monitor ValueGet Monitor Trend ValuesGet All Charts ValuesGet Chart Values

Response Format

All API responses return JSON data.

Success Response:

{
   "STATUS": "SUCCESS",
   "RESPONSE": [{
     "GroupName": "xxxx",
     "CounterName": "xxxx",
     "Value": "Yes",
     "AlertStatus": "1",
     "AlertCondition": "None"
   }]
}

Failure Response:

{
   "STATUS": "FAILURE",
   "RESPONSE": "Error Message"
}

Notes:

• _type is required for monitor queries.
• _starttime and _endtime are needed for historical data and getting trend values.
• Monitor group_id and counter_id are found on the Monitors page.

Chart group_id and counter_id should be displayed on mouse hover in the UI.