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

# Catchpoint API

The Catchpoint API lists and inspects synthetic monitoring tests, retrieves a single test and all of its sections, and updates a test's configuration. It exposes the test objects behind Catchpoint's digital experience monitoring so they can be read and adjusted programmatically. Agents can audit and tune monitoring coverage without clicking through the Catchpoint portal.

## For AI agents

List Catchpoint synthetic monitoring tests, read a single test and its sections, and update a test's configuration. Returns test definitions for an agent to audit or adjust.

## Scope

Does not handle raw performance telemetry, alerting rules, or dashboard rendering. Use for listing, reading, and updating synthetic monitoring tests only.

## Capabilities

- List the synthetic monitoring tests in an account
- Retrieve a single test by its identifier
- Read all sections of a test's configuration
- Update a test's configuration

## Use cases

### Agent-Driven Monitoring Audit

An AI agent reviews an account's synthetic monitoring coverage by listing tests, reading each one's sections, and flagging gaps or misconfigurations. It can then update a test whose settings drifted from the standard. This turns a manual portal review into an automated audit an agent runs on a schedule.

Example prompt: List the account's tests, read each test's sections, and report any whose configuration differs from the expected standard

### Monitoring Configuration Management

Teams keep synthetic tests consistent by reading a test's sections and updating its configuration when standards change. The API returns the full test definition and accepts an update for one test at a time. This suits rolling a configuration change across many tests in a controlled pass.

Example prompt: Read a test's current sections, apply a configuration change, and submit the updated test

### Coverage Reporting

An agent builds a report of what monitoring exists by listing all tests and summarizing their sections. This gives stakeholders a current picture of monitoring coverage without opening the portal. It runs as a recurring digest of the account's synthetic tests.

Example prompt: List all tests and produce a summary of their sections as a monitoring coverage report

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/ui/api/v1/tests` | List monitoring tests |
| GET | `/ui/api/v1/tests/{id}` | Retrieve a test by identifier |
| POST | `/ui/api/v1/tests/{id}` | Update a test's configuration |
| GET | `/ui/api/v1/tests/{id}/allSections` | Read all sections of a test |

## Key resources

- **Tests** — List, retrieve, and update synthetic monitoring tests
- **Test sections** — Read all configuration sections of a single test

## 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:** 49 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 75 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 22 / 100
  - Agent Usability: 94 / 100
  - Security: 100 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/catchpointapi/catchpointapi/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 Catchpoint API by hand means learning its test object shape and building calls to list, read, and update tests and their sections. Through Jentic you install once, import Catchpoint from the API Directory, and your agent lists and updates tests.
- **Permission scoping:** Catchpoint puts the test identifier in the URL path, so a rule can bound your agent to a single test. You can also scope by operation, allowing listing and reading while withholding the update, and every call the agent makes is logged.
- **Credential handling:** The Catchpoint spec does not declare a security scheme, so no secret is required to call it as described. Where a deployment fronts the API with a key, Jentic holds that secret encrypted in your own Jentic One instance and attaches it at execution time, so it never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list monitoring tests' or 'update a test', and Jentic returns the matching Catchpoint operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **Pingdom** — Uptime and synthetic monitoring API for sites and transactions
- **UptimeRobot** — Lightweight uptime monitoring API for endpoints and keywords
- **New Relic** — Observability platform for application performance and telemetry

## FAQ

### What authentication does the Catchpoint API use?

The Catchpoint API's OpenAPI spec does not declare a security scheme, so authentication is not described in the spec itself. Consult the Catchpoint documentation for how to authenticate in production; where a secret is required, Jentic holds it encrypted in your own Jentic One instance and attaches it at call time.

### Can I update a monitoring test with the Catchpoint API?

Yes. The API lets you read a test and all of its sections and then submit an updated configuration for that test. An agent can adjust one test at a time as part of a controlled change.

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

The OpenAPI spec does not specify rate limits. Check the Catchpoint documentation at https://io.catchpoint.com for current limits and usage guidance.

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

Yes. Because the test identifier sits in the URL path, a rule can bound your agent to a single test, and you can scope by operation to allow listing and reading while withholding the update. You choose which operations it may call, and every call is logged.

### How do I audit Catchpoint tests through Jentic?

Search Jentic for 'list monitoring tests', add the Catchpoint API from the directory, and your agent then lists tests and reads their sections. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Is there a Catchpoint MCP server?

You don't need an MCP server to give your agent the Catchpoint API. Jentic connects it directly from the API Directory: import it and your agent lists, reads, and updates tests. Operations are discovered on demand, so no extra server's tool definitions sit in the agent's context.