Skip to main content

Documentation

Complete guide to setting up website monitoring with PingZen. API documentation, code examples, and best practices.

Public Status Pages

Status Pages let you create a public page showing your services’ health. Users can check status without registration.

Features

Public URL

Each status page gets a unique URL like pingzen.dev/status/your-slug.

Customization

Customize the title, description, and theme (light/dark) of your page.

Monitor Selection

Add only the monitors whose status you want to show publicly.

Uptime & SLA

Displays uptime percentages (24h, 7d, 30d, 90d) and timezone-aware uptime bars for each monitor.

Real-time Updates

Status updates automatically without page reload.

Search Engine Indexing

Control whether your status page is indexed by search engines with the allow_indexing toggle.

Display Timezone

Choose how times are shown to visitors. Auto (default) renders every timestamp in each visitor’s own browser timezone — best for a global audience. Pinning a specific IANA timezone (e.g. Europe/Moscow) shows every visitor the same time with a label in the page footer (Times shown in Europe/Moscow (MSK)). See Timezones for the full model.

No Authentication

Public pages are accessible to everyone without registration.

How to Create

  1. Go to “Status Pages” in the sidebar
  2. Click “Create Status Page”
  3. Enter a title and unique slug (URL path)
  4. Select monitors to display
  5. Save and copy the public URL

SLA Reports (PDF)

Every public status page has a Download SLA report button in the header. Any visitor — no account required — gets a PDF snapshot of the page, ready to attach to an SLA review, a postmortem, or a client email.

The report covers the last 90 days and contains only what the public page already shows — no monitor IDs, internal error details, or latency internals leak into it:

  • Current status and overall 90-day uptime across actively monitored services
  • Per-service uptime for the 24h / 7d / 30d / 90d windows
  • A 90-day daily uptime strip for every monitor
  • Incident history (the 50 most recent) and scheduled maintenance windows

Numbers in the PDF match the page exactly — both are built from the same data snapshot:

  • Timestamps follow the page’s display timezone setting.
  • Paused monitors are listed as Paused with N/A in windows that have no data, and are excluded from the overall uptime average.
  • Partial (regional) outages earn half uptime credit — the same rule the SLA formula uses everywhere else in PingZen.
  • The report is generated on the fly, so it always reflects the current state of the page. Unicode content (Cyrillic titles, monitor names) is fully supported.

No setup is needed — the button appears on every public status page automatically.

Sharing

Share your status page URL with users via:

  • A link in your website footer
  • Email notifications about maintenance
  • Social media
  • Internal documentation
  • The downloadable SLA report (PDF) for formal reviews

Status Pages API

Manage status pages via REST API.

GET/api/v1/status-pages

List status pages

POST/api/v1/status-pages

Create status page

PUT/api/v1/status-pages/:id

Update status page

DELETE/api/v1/status-pages/:id

Delete status page

POST/api/v1/status-pages/:id/monitors

Add monitors to page

GET/api/v1/public/status/:slug/report.pdf

Download the SLA report PDF (public, no authentication)

Common Questions

What protocols can I monitor?

PingZen supports 23 protocols: HTTP/HTTPS, WebSocket (WS/WSS), TCP, UDP, ICMP Ping, gRPC, DNS, WHOIS, SSL certificates, Email (SMTP/IMAP/POP3), FTP/FTPS, DNSBL, PageSpeed, SOCKS5, MTProxy, API Check, and Transaction. You can monitor websites, APIs, servers, databases, and any network service.

How fast can I get alerts?

Telegram alerts are delivered within 1-2 seconds of detection. Slack and Discord notifications arrive almost instantly. You can configure multiple alert channels for redundancy.

Can I organize monitors by project?

Yes! PingZen supports workspaces, which let you organize monitors by project, environment, or team. Each workspace can have its own alert configurations and team members.

Is there an API for automation?

Absolutely. PingZen provides a full REST API with OpenAPI documentation. You can create, update, and delete monitors programmatically.

How do status pages work?

Status pages are public, branded pages showing your services' uptime. You can display real-time status and allow customers to subscribe for updates.

What happens if I reach my monitor limit?

We'll notify you when approaching your limit. You can pause some monitors or contact us for increased capacity. We never stop monitoring without warning, ensuring your critical services stay protected.

Ready to stop missing downtime?

Join thousands of teams who trust PingZen. Setup takes 30 seconds.