MonitorsSsh monitors
Get SSH Monitor Details
Consolidated endpoint that returns the SSH monitor details page data in one call.
GET /api/ssh-monitors/:sshMonitorPublicId/details
Authentication
Requires a valid session.
- Header:
Authorization: Bearer <token>
Parameters
sshMonitorPublicId(Path, required): SSH monitor public UUID.
Query Parameters
range(string, optional):day,week,month,year(default:day)date(string, optional): Reference date (parsed bynew Date(date))startDate(string, optional)endDate(string, optional)granularity(string, optional)rawdisables aggregation,aggregatedforces it. Default: raw up to 48 hours.
cURL
curl "https://YOUR_DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444/details?range=day" \
-H "Authorization: Bearer $TOKEN"Response
The response is a single object with these top-level keys:
sshMonitorIdmonitorlatestCheckuptimeStatsuptimeStatsMetamonitoringDataincidentsalertstestResultLogmaintenance
Example (truncated):
{
"sshMonitorId": 300,
"monitor": {
"id": 300,
"customerId": 10,
"name": "Bastion Host",
"hostname": "ssh.deinkunde.com",
"port": 22,
"status": "active",
"checkInterval": 60,
"timeoutSeconds": 30,
"allowedCheckCountryCodes": ["DE"],
"config": {
"username": "root"
}
},
"latestCheck": {
"status": "success",
"checkedAt": "2026-02-26T12:00:00.000Z",
"timingSsh": 123,
"locationCode": "de-nbg",
"locationName": "Nuremberg (DE)"
},
"uptimeStats": {
"day": 99.9,
"month": 99.5,
"year": 99.0,
"dayAvgResponse": 120,
"monthAvgResponse": 140,
"yearAvgResponse": 150
},
"maintenance": {
"inMaintenance": false,
"activeWindows": [],
"allWindows": []
}
}Data retention
Single checks are kept for 24 hours, minute aggregates for 30 days and daily aggregates for 24 months; a range older than 30 days returns one point per day. If the monitor has no check within the last 24 hours, latestCheck describes its last minute from the aggregate: id starts with 1min-, resolution is 1min, and locationId and errorMessage are null.
Errors
400Invalid SSH monitor public ID (UUID)401Unauthorized403Forbidden404Not found500Failed to fetch SSH monitor details
Common Errors
400 Bad Request(invalidRequestBody) ifrangeis notday/week/month/year,date/startDate/endDateis not a date, only one ofstartDate/endDateis given,tzis not an integer, orgranularityis notraw/aggregated