Документация PulseAPI

PulseAPI мониторит API-эндпоинты и оповещает о сбоях. Здесь описана настройка, REST API и ключевые концепции.

Начало работы

Настрой мониторинг за 5 минут.

Справочник API

REST API с примерами curl.

Гайды по фреймворкам

Готовый health-endpoint код для Next.js, Django, Rails, FastAPI, Express, Laravel, NestJS, Spring Boot и TanStack Query.

Headless API

Собирайте свою UI статуса поверх публичного REST + SSE. React, Vue, plain HTML — любой фронтенд.

Ключевые концепции

Эндпоинты

URL для мониторинга. Каждый проверяется с настраиваемым интервалом (1мин — 1ч) по HTTP.

Проверки

Отдельные пробы мониторинга. Каждая записывает код ответа, время и результаты проверок.

Оповещения

Срабатывают автоматически после 2+ последовательных сбоев. Оповещения о восстановлении и медленных ответах (1/час).

Страницы статуса

Публичные страницы с состоянием эндпоинтов, полосами аптайма и инцидентами. Свои домены и брендинг.

Инциденты

Отслеживание сбоев с обновлениями, уровнями критичности и постмортемами. Подписчики уведомляются автоматически.

Базовый URL

https://api.pulseapi.tech

Все API-эндпоинты относительно этого URL.

Публичные эндпоинты (без auth)

Эти эндпоинты отдают те же данные, что видят клиенты на хостед-странице. Безопасны для браузера; идеальны для встраивания статуса в своё приложение, README или доки.

GET/status/:slugДанные статуса

JSON с метаданными страницы, общим статусом, статусами эндпоинтов, массивами uptime, инцидентами и компонентами.

SSE/sse/status/:slugRealtime-стрим (SSE)

Server-Sent Events — изменения статуса, новые инциденты и результаты проверок в реальном времени. Без polling.

GET/badge/:slug/uptime.svgВстраиваемые бейджи

Shields.io-совместимые SVG-бейджи: процент uptime, текущий статус, среднее время отклика. Вставляйте в любой README или лендинг.

Пример realtime

const es = new EventSource('https://api.pulseapi.tech/sse/status/acme')

es.addEventListener('status:changed', (e) => {
  const payload = JSON.parse(e.data)
  updateBanner(payload.status)
})

es.addEventListener('incident:created', (e) => {
  showNotification(JSON.parse(e.data))
})

Быстрый пример

# Create an API key in Dashboard > Settings > API Keys, then:

# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints

# Create a new endpoint
curl -X POST https://api.pulseapi.tech/endpoints \
  -H "Authorization: pk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"name":"My API","url":"https://api.example.com/health","method":"GET","checkInterval":300,"timeout":10}'

# Check uptime stats
curl -H "Authorization: pk_live_abc123..." \
  "https://api.pulseapi.tech/endpoints/ENDPOINT_ID/stats?period=24h"

Готов начать? Читай Начало работы или перейди к Справочник API.