canonical: https://jentic.com/apis/uptimetoolbox.com/uptimetoolbox

# UptimeToolbox API

Official API for UptimeToolbox. Monitor your infrastructure with heartbeat checks, node monitoring, and response tracking. The API exposes 4 endpoints secured with apiKey, bearer authentication.

## For AI agents

Programmatically create heartbeat ping, get heartbeat details. Covers 4 operations with apiKey, bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for analytics only.

## Capabilities

- Create heartbeat ping
- Get heartbeat details
- Integrate UptimeToolbox API into automated workflows
- Query and filter UptimeToolbox API records by parameters
- Monitor UptimeToolbox API operational status and events

## Use cases

### Analytics Operations

Use the UptimeToolbox API to perform analytics operations programmatically. The API provides 4 endpoints covering core functionality including create heartbeat ping, get heartbeat details, create node response.

Example prompt: Call POST `/heartbeat/{heartbeat}` to create heartbeat ping

### Automated heartbeat Management

Automate heartbeat operations by combining multiple UptimeToolbox API endpoints. Agents can get heartbeat details and then create node response in a single workflow.

Example prompt: Call GET `/heartbeat/{heartbeat}` to get heartbeat details, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call UptimeToolbox API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, bearer tokens manually.

Example prompt: Search Jentic for 'create heartbeat ping', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/heartbeat/{heartbeat}` | Create heartbeat ping |
| GET | `/heartbeat/{heartbeat}` | Get heartbeat details |
| POST | `/node-response` | Create node response |
| GET | `/node/by-guid/{guid}` | Get node by GUID |

## Key resources

- **heartbeat** — Heartbeat monitoring operations
- **node** — Node management operations
- **node-response** — Node response tracking

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 62 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 38 / 100
  - Agent Usability: 94 / 100
  - Security: 55 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/uptimetoolbox.com/uptimetoolbox/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the UptimeToolbox API by hand means combining its bearer token with the X-ORGANIZATION-ID header on every call and routing heartbeat and node requests yourself. Through Jentic you install once, import UptimeToolbox from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** UptimeToolbox puts the heartbeat id in the URL path (`/heartbeat/{heartbeat}`), so a rule can pin your agent to one heartbeat: it can post and read that heartbeat and nothing else. You choose the operations it may call, so nothing beyond the ones you list runs.
- **Credential handling:** Your UptimeToolbox bearer token and organization id are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'post a heartbeat ping' or 'read a node by GUID', and Jentic returns the matching UptimeToolbox operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the UptimeToolbox API use?

The UptimeToolbox API uses apiKey, bearer authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create heartbeat ping with the UptimeToolbox API?

Yes. Use the POST `/heartbeat/{heartbeat}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the UptimeToolbox API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create heartbeat ping through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create heartbeat ping'. Jentic returns the matching UptimeToolbox API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the UptimeToolbox API have?

The UptimeToolbox API exposes 4 endpoints covering heartbeat, node, node-response operations.

### Can I limit what my agent is allowed to do with the UptimeToolbox API?

Yes. Because you run Jentic One yourself, your own rules decide which UptimeToolbox operations and credentials the agent may use, so it only calls the endpoints you list, such as posting a heartbeat ping or reading heartbeat details, and nothing else runs. Since UptimeToolbox puts the heartbeat id in the URL path at `/heartbeat/{heartbeat}`, a rule can pin the agent to a single heartbeat, letting it post and read that one heartbeat while blocking every other. You can also decide whether it may reach node and node-response operations like GET `/node/by-guid/{guid}` or POST /node-response at all.