canonical: https://jentic.com/apis/io.catchpoint.com/catchpoint

# Io Catchpoint Catchpoint API

Jentic publishes the only available OpenAPI specification for Catchpoint API, keeping it validated and agent-ready. Catchpoint is a digital experience monitoring platform that runs synthetic web, transaction, and API tests from a global node network and surfaces availability, performance, and BGP signals. This minimal slice of the API exposes the core test catalogue: list every configured test, retrieve a single test by id, update its configuration, and pull the section breakdown that drives Catchpoint's waterfall analysis.

## For AI agents

Read and update Catchpoint synthetic test configurations and pull section breakdowns so an agent can audit or tune a monitoring estate.

## Scope

Does not handle alert routing, log aggregation, or APM tracing - use for Catchpoint synthetic test configuration and section breakdowns only.

## Capabilities

- List every synthetic test configured in the Catchpoint account
- Retrieve the full configuration of a single Catchpoint test by id
- Update an existing test configuration without touching the UI
- Pull the all-sections breakdown that powers waterfall and timing analysis
- Audit the monitoring estate by diffing test configurations across environments
- Stage configuration changes programmatically before promoting them to production

## Use cases

### Monitoring Estate Audit

SRE and observability teams running large Catchpoint estates can pull every test through GET `/ui/api/v1/tests`, diff the returned configurations against a desired-state file, and flag drift for review. The audit replaces a manual UI walk-through and gives a versionable snapshot of monitoring intent.

Example prompt: List every Catchpoint test, fetch each one by id, and diff the URL and threshold fields against the desired-state file.

### Programmatic Test Tuning

Performance engineers can update test configurations via POST `/ui/api/v1/tests/{id}` when a target URL changes or alert thresholds need adjustment, then verify the new configuration without touching the Catchpoint UI. This is useful when rolling out an environment migration across many tests.

Example prompt: Update test 12345 to point at the new staging URL and confirm the GET response reflects the change.

### Waterfall Section Analysis

The all-sections endpoint exposes the breakdown that drives Catchpoint's waterfall view, which lets engineers post-process timings without screenshotting the UI. An agent can pull sections for a list of tests, compute per-step averages, and feed the result into a weekly performance report.

Example prompt: Pull the all-sections breakdown for test 12345 and summarise the average duration of each section.

### Agent-Driven Monitoring Hygiene

An AI agent connected via Jentic can keep a Catchpoint estate clean: list tests, identify ones whose URLs still reference a deprecated environment, push the corrected URL via POST, and report the change set. The agent searches Jentic by intent rather than wiring the four endpoints by hand.

Example prompt: List all tests, find the ones still pointing at staging-old.example.com, and update each to staging.example.com.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/ui/api/v1/tests` | List all configured tests |
| GET | `/ui/api/v1/tests/{id}` | Retrieve a single test by id |
| POST | `/ui/api/v1/tests/{id}` | Update a test configuration |
| GET | `/ui/api/v1/tests/{id}/allSections` | Get all-sections breakdown for a test |

## Key resources

- **Tests** — List, retrieve, and update synthetic test configurations.
- **Sections** — Pull the per-test all-sections breakdown for waterfall analysis.

## Why Jentic

- **Setup:** Wiring the Catchpoint API by hand means obtaining an OAuth bearer token, sending it on every request, and hand-navigating the synthetic-test and section-breakdown paths yourself. Through Jentic you install once, import Catchpoint from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Catchpoint puts the test id in the URL path (`/ui/api/v1/tests/{id}`, `/ui/api/v1/tests/{id}/allSections`), so a rule can pin your agent to one test: it can read that test and its section breakdowns and nothing else. You choose the operations it may call, so the POST update to a test is not included unless you add it.
- **Credential handling:** Your Catchpoint token is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list synthetic tests' or 'update a Catchpoint test', and Jentic returns the matching test or section operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **New Relic** — New Relic Synthetics offers managed synthetic monitoring tied to New Relic APM and Browser data.
- **Pingdom** — Pingdom is a long-standing synthetic monitoring service focused on uptime and basic transaction checks.
- **UptimeRobot** — UptimeRobot adds lightweight uptime checks on top of the deeper Catchpoint synthetic estate.

## FAQ

### Why is there no official OpenAPI spec for Catchpoint API?

Catchpoint does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Catchpoint API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Catchpoint API use?

The published OpenAPI document does not declare a securityScheme; Catchpoint accounts are typically accessed via OAuth client credentials issued in the portal and the bearer token is sent in the Authorization header. Through Jentic the credential is held in the encrypted vault and injected at execution time.

### Can I list every synthetic test in my account?

Yes. GET `/ui/api/v1/tests` returns the configured tests for the account; pair it with GET `/ui/api/v1/tests/{id}` to read each test's full configuration when you need fields beyond the summary.

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

Catchpoint applies per-account API throttling that is documented in the customer portal rather than in the OpenAPI spec; in practice the listing and retrieval endpoints used here are read-cheap, while POSTs to update tests should be batched to avoid 429 responses.

### How do I update a Catchpoint test through Jentic?

Search Jentic for 'update a Catchpoint test', load the schema for POST `/ui/api/v1/tests/{id}`, and execute with the changed fields. Run pip install jentic, then await client.search, await client.load, await client.execute.

### What is the all-sections endpoint useful for?

GET `/ui/api/v1/tests/{id}/allSections` returns the per-section breakdown that drives Catchpoint's waterfall view, which lets an agent compute step-level timings and aggregate them into a report without scraping the UI.

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

Yes. Because you run Jentic One yourself, your own rules decide which Catchpoint operations and credentials the agent may use. Since the test id lives in the URL path, you can pin the agent to a single test so it only reads that test via GET `/ui/api/v1/tests/{id}` and its breakdown via GET `/ui/api/v1/tests/{id}/allSections.` The POST update to `/ui/api/v1/tests/{id}` stays off limits unless you explicitly grant it.