patch.moi/docs/pages/reference/http-api.md
2026-05-16 03:20:02 +00:00

44 lines
831 B
Markdown

---
title: HTTP API
description: Health, update-trigger inspection, retry, replay, and dispatch history.
---
# HTTP API
## Health
```text
GET /healthz
```
Returns `ok`.
## Flow events
```text
GET /flow-events?type=<type>&limit=<n>
GET /flow-events/:id?limit=<n>
POST /flow-events/:id/retry
POST /flow-events/:id/replay
```
The list endpoint returns stored events newest first. The detail endpoint
returns the event and matching dispatch records.
These endpoints inspect update triggers and dispatch attempts. They do not
inspect or modify Git patch stacks directly.
## Dispatches
```text
GET /flow-dispatches?eventId=<id>&status=dispatched|failed|skipped&limit=<n>
```
## Admin auth
When `PATCH_ADMIN_TOKEN` is set, flow endpoints require one of:
```text
Authorization: Bearer <token>
X-Patch-Admin-Token: <token>
```