> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Pingdom plugin

> Pingdom is a website uptime and performance monitoring service. This plugin manages uptime checks of every documented type, reads raw results, root cause analyses and summaries, runs one-off checks, schedules maintenance windows, and manages alerting teams and contacts.

Use **Pingdom** through Corsair: one client, typed API calls.

Authenticate with an API token generated inside My Pingdom; the plugin sends it as an Authorization Bearer token. Every call goes against [https://api.pingdom.com/api/3.1](https://api.pingdom.com/api/3.1). Answers are bare objects keyed by resource (\{checks: \[…], check: \{…}, message: …}); errors carry \{error: \{statuscode, statusdesc, errormessage}}. Timestamps are UNIX seconds everywhere (from/to filters, lasttesttime, maintenance windows).
checks.create takes name, host and type plus type-specific settings in typeSettings as flat body fields (url/encryption/port for http, stringtoexpect for tcp, nameserver/expectedip for dns, …) — the docs list them per type. resolution is one of 1, 5, 15, 30 or 60 minutes. checks.updateMulti pauses or re-times the listed checks at once. tools.runSingle performs a one-off test without creating a check.
Maintenance windows silence alerts for the uptime (uptimeIds) and transaction (tmsIds) checks they cover; recurrenceType is none, day, week or month with repeatEvery, and from/to must be in the future. Deleting checks, teams, contacts or maintenance windows cannot be undone.
The transaction-check (/tms) group and traceroute are documented by Pingdom but not part of this plugin. Every operation is described in the official reference: [https://docs.pingdom.com/api/](https://docs.pingdom.com/api/)

**What you get:**

* 40 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/pingdom better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/pingdom better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/pingdom better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/pingdom better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { pingdom } from '@corsair-dev/pingdom';

export const corsair = createCorsair({
	plugins: [
		pingdom(),
	],
	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!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Pingdom API key before the first call: `pnpm corsair setup --plugin=pingdom --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> pingdom()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

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

## Example API calls

**List checks**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pingdom.api.checks.list({ includeTags: true });
```

**Create an HTTP check**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pingdom.api.checks.create({ name: 'api', host: 'example.com', type: 'http' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/pingdom/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/pingdom/api.md)
>
> Every `pingdom.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.