# Hyperping

> Connect a Hyperping project to Tidal Control with a read-only API key, so compliance tests read its uptime monitors, healthchecks and status pages. Read-only.

Source: https://tidalcontrol.com/docs/integrations/hyperping

Tidal Control's Hyperping integration reads the configuration and state of one Hyperping project for compliance purposes. It authenticates with a project API key against the Hyperping REST API. Uptime monitoring, alerting and incident communication are what auditors ask about under availability, monitoring and incident management, and this integration turns your Hyperping setup into evidence for them.

## What this integration monitors

- **Uptime monitors:** Whether each monitor is active and up, how often it checks, from how many regions, and whether it pages someone through an escalation policy
- **Certificates and domains:** Whether HTTPS monitors alert before a certificate expires, whether any monitored certificate expires within 14 days, and whether domain expiry alerts are on
- **Healthchecks:** Whether the cron and heartbeat checks that watch backups and other scheduled jobs are receiving their pings
- **Outages:** Whether any outage has stayed open for more than three days
- **Status pages:** Whether a status page is published, and whether incidents posted on it are closed with a resolved update

## Requirements

- Super User role in Tidal Control
- A Hyperping user who can open the project's **Developers** settings
- One connection per Hyperping project, because an API key belongs to a single project

## Configuration step-by-step plan

We'll create a **read-only API key** in Hyperping, then add the connection in Tidal Control.

**Configuration steps:**

1. **Create a read-only API key**
2. **Configure the integration in Tidal Control**

## Step 1: Create a read-only API key

- In [Hyperping](https://app.hyperping.io), open the project you want to connect
- Go to **Settings → Developers** and click **Create API key**
- Give it a name, for example `Tidal Control`
- Set **Permissions** to **Read-only**
- Choose an **Expiration**, or **Never** if your key policy allows it
- **Copy the key** immediately: it is shown only once

> **info:**

**Why read-only is enough.** A read-only key can call the GET endpoints only. It cannot create, change, pause or delete monitors or healthchecks, cannot acknowledge or resolve outages, and cannot publish to a status page or message its subscribers. Tidal Control never writes to Hyperping.

## Step 2: Configure the integration in Tidal Control

- Go to **Settings → Integrations** in Tidal Control
- Click the **plus icon** next to **Hyperping**
- Fill in the configuration:
  - **Name:** A descriptive name, for example `Hyperping production`
  - **API key:** The key from step 1
- Click **"Create"** to save the integration

To connect another Hyperping project, create a key in that project and add a second connection.

## Configuration fields explained

The integration dialog asks for the following values:

**Name:**
- A descriptive name for this connection
- For example: `Hyperping`, `Hyperping production`

**API key:**
- The read-only key from step 1
- Required, stored as a secret, and must not contain spaces

## What Tidal Control reads, and what it leaves out

Tidal Control reads monitors, status pages, ongoing outages, status page incidents and healthchecks. Some fields in those responses can hold secrets or personal data, and these are never stored:

- Monitor request headers, request bodies and browser check variables, where teams often keep tokens for authenticated endpoints
- The user name, password, query string and fragment of any monitored URL
- The private ping token and ping URL of a healthcheck, which anyone could use to report a job as healthy
- The email address of whoever acknowledged an outage, and the subscribers of a status page

## Verification

The integration is working when all of the following are true:

- Settings → Integrations shows Hyperping under **Configured Integrations**
- Hyperping tests are available in the Tests section
- Test refresh delivers results without authentication errors

## Frequently asked questions

**Why are paused monitors not failing every test?**
Pausing a monitor is a deliberate choice. The test that every monitor is active reports a paused monitor once, and the other monitor tests leave it out, so one paused monitor does not fail a dozen tests.

**Our project uses the Free plan. Will the tests still work?**
Yes. None of the endpoints this integration reads is limited to a paid plan, and the Free plan's five-minute check interval passes the check-frequency test.

**What happens when the key expires?**
Every fetch fails with an authentication error until you paste a new key. Open the connection under Settings → Integrations and replace the key there.

## Common problems

**"API key is required"**
- The field is empty. Paste the key from step 1

**Authentication errors after a refresh**
- The key was revoked or has expired. Create a new read-only key and update the connection

**No monitors or status pages found**
- The key belongs to a different project than the one you meant. Keys are per project, so create one in the right project

### Still can't figure it out?

Send an email to support@tidalcontrol.com, and we'll get back to you as soon as possible.

> **info:**

**Gather support info:** Note which browser you're using, exact error messages, and which steps you've already tried. This speeds up the solution considerably.
