Documentação do PulseAPI

O PulseAPI monitora seus endpoints de API e alerta quando algo dá errado. Esta documentação cobre configuração, a API REST e conceitos-chave.

Primeiros passos

Configure o monitoramento em menos de 5 minutos.

Referência da API

API REST completa com exemplos curl.

Guias por framework

Código copy-paste de health endpoint para Next.js, Django, Rails, FastAPI, Express, Laravel, NestJS, Spring Boot e TanStack Query.

API headless

Construa sua própria UI de status sobre nosso REST + stream SSE público. React, Vue, HTML puro — qualquer frontend.

Conceitos-chave

Endpoints

URLs que você deseja monitorar. Cada endpoint é verificado em um intervalo configurável (1 min a 1 hora) via HTTP.

Verificacoes

Sondas de monitoramento individuais. Cada check registra código de status, tempo de resposta e resultados opcionais de asserções.

Alertas

Acionados automaticamente após 2+ falhas consecutivas. Alertas de recuperação são enviados quando o endpoint volta. Alertas de resposta lenta são limitados a 1/hora.

Páginas de status

Páginas públicas exibindo a saúde dos endpoints, barras de disponibilidade e incidentes. Suportam domínios personalizados e branding.

Incidentes

Acompanhe interrupções com atualizações na linha do tempo, níveis de severidade e postmortems. Os assinantes são notificados automaticamente.

URL base

https://api.pulseapi.tech

Todos os endpoints da API são relativos a esta URL base.

Endpoints públicos (sem auth)

Estes endpoints servem os mesmos dados que seus clientes veem na página hospedada. Seguro chamar do navegador; ideais para embedar status em seu app, README ou docs.

GET/status/:slugDados de status

JSON com metadados da página, status geral, status de endpoints, arrays de uptime, incidentes e componentes.

SSE/sse/status/:slugStream em tempo real (SSE)

Stream Server-Sent Events — receba mudanças de status, novos incidentes e resultados de checks na hora. Sem polling.

GET/badge/:slug/uptime.svgBadges embutíveis

Badges SVG compatíveis com Shields.io: porcentagem de uptime, status atual e tempo médio de resposta. Coloque em qualquer README ou landing.

Exemplo em tempo real

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))
})

Exemplo rápido

# 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"

Pronto para começar? Leia a Primeiros passos ou vá para a Referência da API.