API & Integrations
    Feature Guide

    API Endpoints Reference

    Overview of available API endpoints and their usage.

    Updated 2026-02-23
    1 min read
    API
    endpoints
    REST

    API Endpoints Reference#

    Sites#

    MethodEndpointDescription
    GET/api/v1/sitesList all monitored sites
    GET/api/v1/sites/:idGet site details
    POST/api/v1/sitesAdd a new site
    PUT/api/v1/sites/:idUpdate site settings
    DELETE/api/v1/sites/:idRemove a site

    Checks#

    MethodEndpointDescription
    GET/api/v1/sites/:id/checksList check results
    POST/api/v1/sites/:id/checksTrigger a new check
    GET/api/v1/sites/:id/uptimeGet uptime data

    Reports#

    MethodEndpointDescription
    GET/api/v1/sites/:id/reportGenerate a report
    GET/api/v1/sites/:id/exportExport data (CSV/JSON)

    Alerts#

    MethodEndpointDescription
    GET/api/v1/alertsList all alerts
    PUT/api/v1/alerts/:id/acknowledgeAcknowledge an alert

    Pagination#

    All list endpoints support pagination:

    GET /api/v1/sites?page=1&per_page=25

    Response Format#

    All responses follow a consistent JSON structure:

    {
      "data": [...],
      "meta": {
        "total": 50,
        "page": 1,
        "per_page": 25
      }
    }
    Was this article helpful?