uptime-kuma-rest-api

Uptime Kuma REST API Library

This typescript library contains methods which enables user to use the Uptime Kuma REST API

Uptime Kuma Info

• Website
• Documentation
• REST API
• Source

Setup

Get the API Key from the Uptime Kuma

Settings -> API Keys -> Add API Key

Note: Make sure it is kept safe and secret.

If user wants to login to REST API using API key then use password as API key with username as empty

If user wants to login to REST API using username and password then provide the same in config below

Configuration

import { UptimeKumaClient } from "uptime-kuma-rest-api"

const uptimeKumaClient = new UptimeKumaClient({
    host: "http://uptimekuma.tld",
    authentication: {
        username: "",
        password: "uk1_aJUxxxxxxxxxxxxxxxxxxxxx"
    }
})

// OR
const uptimeKumaClient = new UptimeKumaClient({
    host: "http://uptimekuma.tld",
    authentication: {
        username: "test_user",
        password: "test_password"
    }
})

Usage

const entryPage = await uptimeKumaClient.main.getEntryPage()
console.log(`entryPage \n${JSON.stringify(entryPage)}`)

const uptimekuma = await uptimeKumaClient.main.getStatus("uptimekuma")
console.log(`uptimekuma \n${JSON.stringify(uptimekuma)}`)

const heartbeat = await uptimeKumaClient.main.getHeartbeat("uptimekuma")
console.log(`heartbeat \n${JSON.stringify(heartbeat)}`)

const overallStatusBadge = await uptimeKumaClient.badges.getOverallStatusBadge("uptimekuma")
console.log(`overallStatusBadge \n${overallStatusBadge}`)

const monitorStatusBadge = await uptimeKumaClient.badges.getMonitorBadge(27)
console.log(`monitorStatusBadge \n${monitorStatusBadge}`)

const monitorUptimeBadge = await uptimeKumaClient.badges.getMonitorUptimeBadge(27, "1h")
console.log(`monitorUptimeBadge \n${monitorUptimeBadge}`)

const monitorPingBadge = await uptimeKumaClient.badges.getMonitorPingBadge(27, "1h")
console.log(`monitorPingBadge \n${monitorPingBadge}`)

const monitorCertificateExpiryBadge = await uptimeKumaClient.badges.getMonitorCertificateExpiryBadge(27)
console.log(`monitorCertificateExpiryBadge \n${monitorCertificateExpiryBadge}`)

License

Licensed under GNU