Uptime Kuma
App · 4 actions
Watch your sites and services in Uptime Kuma: get monitors' status, uptime and certificates, read a status page, send push heartbeats, and start a workflow when a monitor goes down or comes back up.
Actions
| Action | What it does |
|---|---|
| Get monitor status | Get one monitor's status (up, down, pending or in maintenance), last response time, certificate expiry and uptime. |
| Get status page | Read a status page as visitors see it: its overall status, pinned incidents, maintenance, and each monitor's latest check and uptime over 24 hours. |
| List monitors | List the monitors Uptime Kuma is checking, with each one's status (up, down, pending or in maintenance), response time, certificate expiry and uptime, and how many are up and down. |
| Send push heartbeat | Tell a push monitor that a job ran (up) or failed (down), with a message and how long it took, such as at the end of a backup. |
Get monitor status
Get one monitor's status (up, down, pending or in maintenance), last response time, certificate expiry and uptime.
Inputs
- Monitor
monitortextRequired - The monitor's name, or its ID on Uptime Kuma 2.
Outputs
addresstext- The address or host it checks; empty for a push monitor
avg_response_time_24h_msnumber- Its average response time over 24 hours, in milliseconds; empty on Uptime Kuma version 1
cert_days_remainingnumber- Days until its site's certificate expires; empty when it has none
cert_validtrue/false- Whether its certificate is valid; empty when it has none
idnumber- The monitor's ID, as in its link; empty on Uptime Kuma version 1
is_uptrue/false- Whether its status is up
linktext- A link to it in Uptime Kuma (its dashboard on version 1)
nametext- Its name
response_time_msnumber- How long its last check took, in milliseconds
statustext- up, down, pending (failing, retrying before it counts as down) or maintenance
typetext- What it checks with: http, keyword, port, ping, push, dns and so on
uptime_1y_percentnumber- Percent of the last year it was up; empty on Uptime Kuma version 1
uptime_24h_percentnumber- Percent of the last 24 hours it was up; empty on Uptime Kuma version 1
uptime_30d_percentnumber- Percent of the last 30 days it was up; empty on Uptime Kuma version 1
Example output
{
"address": "https://www.example.com/",
"avg_response_time_24h_ms": 175.4,
"cert_days_remaining": 47,
"cert_valid": true,
"id": 3,
"is_up": true,
"link": "https://status.example.com/dashboard/3",
"name": "Website",
"response_time_ms": 182,
"status": "up",
"type": "http",
"uptime_1y_percent": 99.95,
"uptime_24h_percent": 99.93,
"uptime_30d_percent": 99.98
}Get status page
Read a status page as visitors see it: its overall status, pinned incidents, maintenance, and each monitor's latest check and uptime over 24 hours.
Inputs
- Status page
status_pagetextRequired - The status page's slug, the end of its address (…/status/our-services), or the address.
Outputs
descriptiontext- Its description
down_countnumber- How many of them are down
incidentslist- Incidents pinned to the page
linktext- Its address
maintenancelist- Maintenance shown on the page now
monitor_countnumber- How many monitors the page shows
monitorslist- The monitors on the page, by group
overall_statustext- operational, partially_degraded, degraded, maintenance or unknown
overall_status_texttext- The same as the page says it, such as All Systems Operational
slugtext- The page's slug
titletext- Its title
up_countnumber- How many of them are up
Example output
{
"description": "Live status of our public services",
"down_count": 1,
"incidents": [
{
"content": "Logins are slow for some users. We're looking into it.",
"created_at": "2026-11-06T08:12:40Z",
"style": "warning",
"title": "Slow logins",
"updated_at": ""
}
],
"link": "https://status.example.com/status/our-services",
"maintenance": [],
"monitor_count": 2,
"monitors": [
{
"cert_days_remaining": 47,
"group": "Services",
"id": 3,
"last_checked_at": "2026-11-06T09:01:00Z",
"name": "Website",
"response_time_ms": 182,
"status": "up",
"type": "http",
"uptime_24h_percent": 99.93
},
{
"cert_days_remaining": null,
"group": "Services",
"id": 4,
"last_checked_at": "2026-11-06T09:01:02Z",
"name": "Sign-in",
"response_time_ms": null,
"status": "down",
"type": "http",
"uptime_24h_percent": 97.2
}
],
"overall_status": "partially_degraded",
"overall_status_text": "Partially Degraded Service",
"slug": "our-services",
"title": "Our services",
"up_count": 1
}List monitors
List the monitors Uptime Kuma is checking, with each one's status (up, down, pending or in maintenance), response time, certificate expiry and uptime, and how many are up and down. Filter by status, name or a certificate expiring soon.
Inputs
- Status
statustext - Only monitors in this state.One of:
any,down,up,pending,maintenance(In maintenance),problems(Down or pending). Default:any. - Name contains
name_containstext - Only monitors whose name has these words.
- Certificate expires within (days)
cert_expires_within_daysnumber - Only monitors whose site's certificate expires within this many days.From 0 to 3650.
Outputs
countnumber- How many monitors match
down_countnumber- How many of all monitors are down
maintenance_countnumber- How many of all monitors are in maintenance
monitorslist- The monitors that match, by name
pending_countnumber- How many of all monitors are pending
totalnumber- How many monitors Uptime Kuma is checking
up_countnumber- How many of all monitors are up
Example output
{
"count": 2,
"down_count": 1,
"maintenance_count": 0,
"monitors": [
{
"address": "https://www.example.com/",
"avg_response_time_24h_ms": 175.4,
"cert_days_remaining": 47,
"cert_valid": true,
"id": 3,
"is_up": true,
"link": "https://status.example.com/dashboard/3",
"name": "Website",
"response_time_ms": 182,
"status": "up",
"type": "http",
"uptime_1y_percent": 99.95,
"uptime_24h_percent": 99.93,
"uptime_30d_percent": 99.98
},
{
"address": "",
"avg_response_time_24h_ms": null,
"cert_days_remaining": null,
"cert_valid": null,
"id": 5,
"is_up": false,
"link": "https://status.example.com/dashboard/5",
"name": "Nightly backup",
"response_time_ms": null,
"status": "down",
"type": "push",
"uptime_1y_percent": 99.9,
"uptime_24h_percent": 95.83,
"uptime_30d_percent": 99.86
}
],
"pending_count": 0,
"total": 2,
"up_count": 1
}Send push heartbeat
Tell a push monitor that a job ran (up) or failed (down), with a message and how long it took, such as at the end of a backup. Uptime Kuma alerts when the heartbeats stop.
Inputs
- Push URL
push_tokentextRequired - The push monitor's Push URL, from its settings in Uptime Kuma, or the token at its end.
- Status
statustext - Whether the job worked.One of:
up,down. Default:up. - Message
messagetext - What to show with the heartbeat in Uptime Kuma, such as what the job did. Leave blank for OK.
- Response time (ms)
response_timenumber - How long the job took, in milliseconds, shown on the monitor's chart.At least 0.
Outputs
messagetext- The message sent
response_time_msnumber- The response time sent, in milliseconds
senttrue/false- Whether Uptime Kuma took the heartbeat
sent_attext- When it was sent (ISO 8601, UTC)
statustext- The status sent: up or down
Example output
{
"message": "Backup finished: 2.4 GB",
"response_time_ms": 5400,
"sent": true,
"sent_at": "2026-11-06T02:00:12Z",
"status": "up"
}