Skip to main content

Java + Bedrock • Redis cache • Webhook fan-out

Ping Minecraft servers, ship webhook alerts.

Minecraft server status API with webhook notifications. Cache Java lookups in Redis, persist snapshots in Postgres, and notify your downstream apps with one POST.

Get started Deploy on your own GitHub

This site hosts both the hosted API guide and the self-host playbook. The managed endpoints are also reachable at mc-pulse.vercel.app (no ports required) if you just need a ready-made deployment.

Low-latency Redis cachePostgres historySecure API keys

Notify every webhook

# Fetch status and broadcast to all webhooks for your API key
curl -X POST "https://mc-pulse.vercel.app/api/notify?host=arch.mc&type=java" \
  -H "x-api-key: key_abc123"

Cache TTL30s

DBPostgres (mc_pulse)

Health/health → { ok: true }

Docs & deployment

Official docs live on the Vercel deployment; the tiles below cover the self-hosted download, API, webhook, and deploy-on-your-own guidance.

Guide

Getting started

Start the guided setup for both the hosted API and the self-hosted flow.

Guide

Deploy on your own

Self-host mc-pulse with Redis, Postgres, and webhook fan-out control.

Guide

Download & install

Grab the repo, configure env vars, and generate Prisma.

Guide

API reference

Endpoints, payload shapes, and caching defaults for status lookups.

Guide

Webhook fan-out

Create keys, register hooks, and broadcast notifications with one POST.

🎮

Java + Bedrock support

Ping both editions with a single API. Bedrock bypasses cache for freshness; Java lookups honor Redis TTLs.

📣

Webhook fan-out

Register webhooks per API key and blast the same status payload to every consumer with one POST.

🧰

Batteries included

Prisma + Postgres for history, Redis for speed, `/health` for checks, and ready-to-copy curl commands.