Skip to Content
API ReferenceOverview

API Reference

The exit1.dev API provides programmatic access to your monitoring checks, history, and statistics.

Note: API access is available on all plans.

Base URL

All API requests are made to:

https://us-central1-exit1-dev.cloudfunctions.net/publicApi

Conventions

  • REST architecture - Resources are accessed via standard HTTP methods
  • JSON responses - All responses are returned in JSON format
  • API versioning - All endpoints are prefixed with /v1/
  • Scoped access - Write and delete operations require API key scopes

Available Endpoints

Read Endpoints

EndpointDescription
GET /v1/public/checksList all checks
GET /v1/public/checks/{id}Get a single check
GET /v1/public/checks/{id}/historyGet check history
GET /v1/public/checks/{id}/statsGet uptime statistics

Write Endpoints

EndpointScope RequiredDescription
POST /v1/public/checkschecks:writeCreate a new check
PATCH /v1/public/checks/{id}checks:writeUpdate an existing check
DELETE /v1/public/checks/{id}checks:deleteDelete a check
POST /v1/public/checks/{id}/togglechecks:writeEnable or disable a check

Quick Start

  1. Create an API key with the appropriate scopes
  2. Include the key in the X-Api-Key header
  3. Make your first request:
curl -H "X-Api-Key: ek_live_your_api_key_here" \
  https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks
Last updated on
Uptime StatisticsAuthentication