# Flare API API

**Canonical:** https://apis.io/apis/flareapp-io/flare-api-api/  
**Provider:** Flare — https://apis.io/providers/flareapp-io/  
**Base URL:** https://flareapp.io/api  
**Documentation:** https://flareapp.io/docs/flare/general/using-the-api

Flare API API is one of 2 APIs that [Flare](https://apis.io/providers/flareapp-io/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Using our easy-to-use REST API you can administer projects, errors, and performance monitoring data.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| GET | `/projects/match` | Find a Flare project for a Laravel Cloud application. |
| GET | `/me` | Get the authenticated user. |
| GET | `/projects` | Get all projects. |
| POST | `/projects` | Create a new project. |
| PATCH | `/projects/{project_id}` | Update a project. |
| DELETE | `/projects/{project_id}` | Delete a project. |
| GET | `/projects/{project_id}/errors` | Get all errors within a project. |
| GET | `/projects/{project_id}/error-count` | Get the number of errors in the given period. |
| GET | `/projects/{project_id}/error-occurrence-count` | Get the number of error occurrences in the given period. |
| GET | `/teams/{team_id}` | Get a team. |
| DELETE | `/teams/{team_id}/users/{user_id}` | Remove a user from a team. |
| GET | `/errors/{error_id}/occurrences` | Get all occurrences for an error. |
| GET | `/errors/{error_id}/insights/{insight_type}` | Get paginated insights for an error. |
| POST | `/errors/{error_id}/resolve` | Resolve an error. |
| POST | `/errors/{error_id}/open` | Reopen an error. |
| POST | `/errors/{error_id}/snooze` | Snooze an error. |
| POST | `/errors/{error_id}/unsnooze` | Unsnooze an error. |
| POST | `/errors/{error_id}/notes` | Add a note to an error. |
| GET | `/error-occurrences/{occurrence_id}` | Get an error occurrence. |
| GET | `/error-occurrences/{occurrence_id}/previous-exceptions/{previous_exception_id}` | Get the frames of a previous exception in an occurrence's exception chain. |
| GET | `/projects/{project_id}/monitoring/summary` | Get the monitoring dashboard summary. |
| GET | `/projects/{project_id}/monitoring/{type}` | List aggregations by type. |
| GET | `/projects/{project_id}/monitoring/{type}/time-series` | Get time series data for an aggregation type. |
| GET | `/aggregations/{type}/{uuid}` | Get a single aggregation with detail. |
| GET | `/aggregations/{type}/{uuid}/traces` | List traces for an aggregation. |
| GET | `/traces/{traceId}` | Get the full span tree for a trace. |
| GET | `/projects/{project_id}/logs` | List log entries with cursor pagination. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/flareapp-io/openapi/_original/flareapp-io-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/flareapp-io/json-schema/flareapp-io-monitoring-trend-schema.json
- **JSONSchema** — https://artifacts.apis.io/flareapp-io/json-schema/flareapp-io-base-project-schema.json
- **JSONSchema** — https://artifacts.apis.io/flareapp-io/json-schema/flareapp-io-paginated-result-schema.json
- **JSONSchema** — https://artifacts.apis.io/flareapp-io/json-schema/flareapp-io-monitoring-aggregation-schema.json
- **JSONSchema** — https://artifacts.apis.io/flareapp-io/json-schema/flareapp-io-error-occurrence-schema.json
- **JSONSchema** — https://artifacts.apis.io/flareapp-io/json-schema/flareapp-io-monitoring-metrics-schema.json

## Other Flare APIs (1)

- [Flare API](https://apis.io/apis/flareapp-io/flare-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/flareapp-io/flare-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/flareapp-io/.