Server Alerts
Returns a list of system alerts and their current status.
Request
| Property | Value |
|---|---|
| Method | GET |
| URL | /api/server/alerts |
| Content-Type | application/json |
| Authentication | Bearer Token |
Request
bashcurl -X GET "{BASE_URL}/api/server/alerts" \
-H "Authorization: Bearer YOUR_TOKEN"
Response Body
Summary
| Parameter | Type | Description |
|---|---|---|
data.success | boolean | Indicates if the request was successful |
data.timestamp | integer | Data timestamp (Unix timestamp in ms) |
data.totalCount | integer | Total number of configured alerts |
data.activeCount | integer | Number of currently active alerts |
Alert Object
| Parameter | Type | Description |
|---|---|---|
data.alerts[].type | string | Alert type (see allowed values below) |
data.alerts[].active | boolean | Indicates if the alert is currently active |
data.alerts[].currentValue | number | Current value of the monitored metric |
data.alerts[].threshold | number | Threshold value that triggers the alert |
data.alerts[].activatedAt | integer | Activation timestamp (Unix timestamp in ms, 0 if inactive) |
data.alerts[].durationSeconds | integer | Duration the alert has been active in seconds |
Allowed values for type
"HIGH_MEMORY_USAGE""HIGH_CPU_USAGE""HIGH_WORK_POOL_USAGE""HIGH_WRITE_POOL_USAGE""HIGH_READ_POOL_USAGE""HIGH_TRANSPORT_POOL_USAGE""LICENSE_EXPIRED""LICENSE_INVALID"
Metadata
| Parameter | Type | Description |
|---|---|---|
metadata.executionTime | integer | Request processing time in milliseconds |
metadata.generatedAt | integer | Response generation timestamp (Unix timestamp in ms) |
Successful Response (200)
json{
"data": {
"success": true,
"timestamp": 1764846400618,
"totalCount": 8,
"activeCount": 0,
"alerts": [
{
"type": "HIGH_MEMORY_USAGE",
"active": false,
"currentValue": 8.82,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
},
{
"type": "HIGH_CPU_USAGE",
"active": false,
"currentValue": 12.43,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
},
{
"type": "HIGH_WORK_POOL_USAGE",
"active": false,
"currentValue": 0,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
},
{
"type": "HIGH_WRITE_POOL_USAGE",
"active": false,
"currentValue": 0,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
},
{
"type": "HIGH_READ_POOL_USAGE",
"active": false,
"currentValue": 0,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
},
{
"type": "HIGH_TRANSPORT_POOL_USAGE",
"active": false,
"currentValue": 0,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
},
{
"type": "LICENSE_EXPIRED",
"active": false,
"currentValue": 0,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
},
{
"type": "LICENSE_INVALID",
"active": false,
"currentValue": 0,
"threshold": 0,
"activatedAt": 0,
"durationSeconds": 0
}
]
},
"metadata": {
"executionTime": 1,
"generatedAt": 1764846400619
}
}
Error Response (4xx/5xx)
| Parameter | Type | Description |
|---|---|---|
message | string | Human-readable error message |
Error Response
json{
"message": "Error message"
}
Support Needed?
Create a free ticket and our support team will provide you necessary assistance.