canonical: https://jentic.com/apis/phareio/phare

# Phareio Phare API

Jentic publishes the only available OpenAPI specification for Phare API, keeping it validated and agent-ready. The Phare API provides 10 endpoints for managing uptime monitors, viewing incidents, and listing projects. It supports creating HTTP monitors that check endpoint availability, pausing and resuming monitors, and retrieving incident data when downtime is detected. API keys can be project-scoped or organization-scoped for multi-project setups.

## For AI agents

Create and manage uptime monitors that check endpoint availability. Pause, resume, and configure HTTP monitors, and retrieve incident records when downtime occurs.

## Scope

Does not handle application performance monitoring, log aggregation, or distributed tracing - use for HTTP uptime monitoring and incident detection only.

## Capabilities

- Create HTTP uptime monitors to track endpoint availability and response times
- Pause and resume monitors for maintenance windows without deletion
- Retrieve incident records with downtime details and resolution status
- List all monitors across projects with their current status
- Manage multiple projects with scoped API key access control

## Use cases

### Automated Uptime Monitoring Setup

Create HTTP uptime monitors programmatically when deploying new services or endpoints. POST `/uptime/monitors` accepts URL, check interval, and alert configuration. Agents can automatically provision monitoring for each new microservice or API endpoint as part of the deployment pipeline, ensuring nothing goes unmonitored.

Example prompt: Create a new uptime monitor via POST `/uptime/monitors` with URL 'https://api.example.com/health', 60-second interval, and HTTP GET method

### Maintenance Window Management

Pause monitors during planned maintenance to avoid false incident alerts, then resume them when maintenance completes. POST `/uptime/monitors/{id}/pause` stops checking temporarily, and POST `/uptime/monitors/{id}/resume` restarts monitoring. Agents can orchestrate this around deployment schedules automatically.

Example prompt: Pause monitor ID 42 via POST `/uptime/monitors/42/pause` before deployment, then resume it via POST `/uptime/monitors/42/resume` after health check passes

### Incident Reporting and Analysis

Retrieve incident records to analyze downtime patterns, measure SLA compliance, or trigger escalation workflows. GET `/uptime/incidents` returns all detected incidents with timestamps, duration, and affected monitors. Agents can aggregate this data for weekly reliability reports or feed it into alerting pipelines.

Example prompt: Retrieve all incidents via GET `/uptime/incidents`, filter for the past 7 days, and calculate total downtime minutes per monitor for an SLA report

### AI Agent Uptime Management via Jentic

AI agents discover and manage Phare uptime monitors through Jentic as part of infrastructure automation workflows. Agents search for monitoring capabilities by intent, receive operation schemas with Bearer auth handled, and create monitors or query incidents without manual integration. This enables self-healing infrastructure patterns.

Example prompt: Search Jentic for 'create an uptime monitor', load the POST `/uptime/monitors` schema, and execute with target URL and check interval parameters

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/uptime/monitors` | List all uptime monitors |
| POST | `/uptime/monitors` | Create a new monitor |
| GET | `/uptime/monitors/{id}` | Get a specific monitor |
| POST | `/uptime/monitors/{id}/pause` | Pause a monitor |
| POST | `/uptime/monitors/{id}/resume` | Resume a paused monitor |
| DELETE | `/uptime/monitors/{id}` | Delete a monitor |
| GET | `/uptime/incidents` | List all incidents |
| GET | `/projects` | List projects |

## Key resources

- **Monitors** — Create, update, pause, resume, and delete uptime monitors
- **Incidents** — Retrieve incident records for detected downtime events
- **Projects** — List projects for multi-project API key scoping

## 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:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 55 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 74 / 100
- **View full report:** https://jentic.com/apis/phareio/phare/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 Phare API by hand means setting up its bearer key against api.phare.io, deciding whether the key is project-scoped or organization-scoped with project selection headers, and formatting the monitor requests yourself. Through Jentic you install once, import the Phare API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Phare puts the monitor id in the URL path (`/uptime/monitors/{id}`), so a rule can pin your agent to one monitor: it can read, pause, or resume that monitor and nothing else. You choose the operations it may call, so destructive ones like deleting a monitor are not included unless you add them.
- **Credential handling:** Your Phare API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list uptime monitors' or 'pause a monitor', and Jentic returns the matching Phare operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **UptimeRobot API** — UptimeRobot offers uptime monitoring with a larger free tier and broader protocol support (HTTP, ping, port, keyword).
- **ConfigCat API** — ConfigCat provides feature flags that can be toggled based on uptime incidents detected by Phare.
- **LaunchDarkly API** — LaunchDarkly provides feature flag management that pairs with Phare's monitoring for automated incident response.

## FAQ

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

Phare does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Phare 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 Phare API use?

The Phare API uses Bearer token authentication. API keys are generated from the Phare control panel and can be project-scoped (acting on a specific project) or organization-scoped (requiring project selection headers). Through Jentic, your API key is stored encrypted and agents never handle the raw token.

### Can I pause monitors during maintenance?

Yes. POST `/uptime/monitors/{id}/pause` temporarily stops a monitor from checking. POST `/uptime/monitors/{id}/resume` restarts it. This prevents false incident alerts during planned maintenance windows without deleting and recreating the monitor.

### How do I retrieve incident data through Jentic?

Search Jentic for 'list uptime incidents' to discover GET `/uptime/incidents.` Load the schema and execute to retrieve incident records including timestamps, affected monitors, and downtime duration. Use this data for SLA reporting or escalation logic.

### What is the difference between project-scoped and organization-scoped API keys?

Project-scoped keys automatically target their assigned project for all operations. Organization-scoped keys require you to specify the target project via request headers, but allow access to multiple projects with a single key. GET /projects lists available projects for organization-scoped keys.

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

Yes. Because you run Jentic One yourself, your own rules decide which Phare operations and credentials your agent can use. Phare puts the monitor id in the URL path (`/uptime/monitors/{id}`), so a rule can pin your agent to a single monitor and let it read, pause, or resume only that one. You pick the operations it may call, so a destructive action like DELETE `/uptime/monitors/{id}` stays out of reach unless you explicitly add it.