louislam-uptime-kuma

Namespace

louislam-uptime-kuma

Description:

  • Experience seamless uptime monitoring with Uptime Kuma. This intuitive, self-hosted tool tracks diverse services and delivers rapid notifications to ensure your operations remain uninterrupted.

Author:
Copyright:
  • 2026 Eyevinn Technology AB
See:

Methods

(async, static) createLouislamUptimeKumaInstance(context, body) → {LouislamUptimeKuma}

Description:

  • Create a new Uptime Kuma instance

Example
import { Context } from '@osaas/client-core';
import { createLouislamUptimeKumaInstance } from '@osaas/client-services';

const ctx = new Context();
const body: LouislamUptimeKumaConfig = { name: 'myinstance', ... };
const instance = await createLouislamUptimeKumaInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body LouislamUptimeKumaConfig

Service instance configuration
Returns:
  • Service instance
Type
LouislamUptimeKuma

(async, static) getLouislamUptimeKumaInstance(context, name) → {LouislamUptimeKuma}

Description:

  • Get a Uptime Kuma instance

Example
import { Context } from '@osaas/client-core';
import { getLouislamUptimeKumaInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getLouislamUptimeKumaInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the monitor to be retrieved
Returns:
  • Service instance
Type
LouislamUptimeKuma

(async, static) removeLouislamUptimeKumaInstance(context, name)

Description:

  • Remove a Uptime Kuma instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the monitor to be removed