Back to Help Center

API

API Reference

Overview of available API endpoints

API Reference

Statly provides a REST API for programmatic access.

Base URL

https://statly.live/api/v1

Authentication

All requests require a Bearer token:

Authorization: Bearer sk_live_xxx

Rate Limits by Plan

| Plan | Rate Limit | |------|------------| | Free | 50 req/min | | Hobby | 100 req/min | | Pro | 300 req/min | | Enterprise | 1000 req/min |

Check the X-RateLimit-Remaining header in responses.

Endpoints

Monitors

GET /monitors - List all monitors
POST /monitors - Create monitor
GET /monitors/:id - Get monitor details
PATCH /monitors/:id - Update monitor
DELETE /monitors/:id - Delete monitor

Incidents

GET /incidents - List incidents
POST /incidents - Create incident
PATCH /incidents/:id - Update incident
POST /incidents/:id/updates - Add update

Status (Public, no auth required)

GET /status/:slug - Get organization status
GET /widget/:slug - Widget data for embedding
GET /badge/:slug/:monitorId - SVG uptime badge

Observe SDK

POST /observe/ingest - Send error events Header: X-Statly-DSN: https://[email protected]/org

Error Responses

{
  "error": {
    "code": "not_found",
    "message": "Monitor not found"
  }
}

Standard HTTP status codes: 400, 401, 403, 404, 429, 500

Related Topics

Creating API Keys

Generate and manage API access tokens

Was this helpful?

Help us improve our documentation