UptimeRobot plugin

• This is the v3 API. The older v2 form-encoded API at /v2 still exists but is not what this plugin wraps; v3 is JSON in and JSON out, with DELETE, PATCH and per-resource paths. The full contract is published as an OpenAPI document at https://cdn.uptimerobot.com/api/openapi.yaml.
• A failure is always { code, message }. The code is stable and grouped by area — 003-* is authentication, 009-* is resources and validation, 026-* is status pages. A wrong or revoked key answers 401 with 003-005. A validation failure instead sends message as an array of per-field strings, and the plugin keeps them on details.
• Creating a monitor depends on its type. The input schema takes the union of all ten types and checks it against the one you chose: HEARTBEAT needs no url at all and rejects one, THIRD_PARTY_SERVICE needs only config, PORT and UDP need a port, KEYWORD needs keywordType, keywordCaseType and keywordValue, HTTP, KEYWORD, PING, PORT, API and UDP need a timeout (UptimeRobot answers 400 without one), DNS, API, UDP and VISUAL_COMPARISON need config, and everything else needs a url. A mismatch is reported before any request is made.
• Pausing is not deleting. monitors.pause stops the checks and the alerts and is reversible with monitors.start; UptimeRobot also pauses a monitor by itself after repeated failures, and monitors.start resumes that too. monitors.delete removes the monitor and its history for good.
• monitors.reset discards history, not the monitor. It clears the accumulated statistics and incident log while the monitor keeps checking, so it is marked destructive even though the monitor survives.
• The interval floor is 30 seconds in the contract. The free plan enforces a much higher floor (five minutes), and asking for less is refused by the API rather than silently raised.
• Paging is a link, and a page can be empty. Lists answer nextLink, which stays set while more pages remain. With a filter on incidents.list, a page can hold fewer items than limit, or none at all, while nextLink is still present — so page on the link, not on the item count. tags.list is the exception: it pages by nextCursorId instead.
• A status page can show everything. monitorIds: [0] on its own is the sentinel for every monitor in the account, and an empty array shows none. autoAddMonitors covers monitors created later, but an explicit monitorIds wins over it — including an empty one.
• Rate limits are tight on the free plan. It allows 10 requests a minute; paid plans allow twice the monitor limit, capped at 5,000. A 429 was refused before it ran, so the plugin retries it up to three times with backoff, honouring Retry-After.

• 31 typed API operations

​

Setup

npm install corsair @corsair-dev/uptimerobot better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/uptimerobot better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/uptimerobot better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/uptimerobot better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { uptimerobot } from '@corsair-dev/uptimerobot';

export const corsair = createCorsair({
	plugins: [
		uptimerobot(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

uptimerobot()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'uptimerobot',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.uptimerobot.api.monitors.list({
	status: ['DOWN', 'LOOKS_DOWN'],
});

const tenant = corsair.withTenant('acme');
await tenant.uptimerobot.api.monitors.update({ id: 778001, friendlyName: 'Acme storefront', interval: 60 });

​

What’s next