Skip to content

Commit 2b80292

Browse files
kanadguptaascorbic
andauthored
docs: correct health check endpoint (#117)
Co-authored-by: Matt Kane <m@mk.gg>
1 parent 92a2b39 commit 2b80292

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

demos/pds/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ No additional code needed!
9090
Once deployed, your PDS will serve:
9191

9292
- `GET /.well-known/did.json` - DID document
93-
- `GET /health` - Health check
93+
- `GET /xrpc/_health` - Health check
9494
- `GET /xrpc/com.atproto.sync.getRepo` - Export repository as CAR
9595
- `GET /xrpc/com.atproto.sync.subscribeRepos` - WebSocket firehose
9696
- `POST /xrpc/com.atproto.repo.createRecord` - Create a record (authenticated)

packages/create-pds/templates/pds-worker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ pnpm dev
5252
The PDS is now running at http://localhost:5173. Test it with:
5353

5454
```bash
55-
curl http://localhost:5173/health
55+
curl http://localhost:5173/xrpc/_health
5656
curl http://localhost:5173/.well-known/did.json
5757
```
5858

packages/pds/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ See [Cloudflare's data location documentation](https://developers.cloudflare.com
387387
| ------------------------------ | ----------------------------------------------------- |
388388
| `GET /.well-known/did.json` | DID document for did:web resolution |
389389
| `GET /.well-known/atproto-did` | Handle verification (only if handle matches hostname) |
390-
| `GET /health` | Health check with version info |
390+
| `GET /xrpc/_health` | Health check with version info |
391391

392392
### Federation (Sync)
393393

0 commit comments

Comments
 (0)