API Reference
The exit1.dev API provides programmatic access to your monitoring checks, history, statistics, and alert channels.
Note: API access is available on all plans.
Base URL
All API requests are made to:
https://us-central1-exit1-dev.cloudfunctions.net/publicApiConventions
- 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
| Endpoint | Description |
|---|---|
GET /v1/public/checks | List all checks |
GET /v1/public/checks/status | Current status of every check, for frequent polling |
GET /v1/public/checks/{id} | Get a single check |
GET /v1/public/checks/{id}/history | Get check history |
GET /v1/public/checks/{id}/stats | Get uptime statistics |
GET /v1/public/account | Plan, limits and usage |
Write Endpoints
| Endpoint | Scope Required | Description |
|---|---|---|
POST /v1/public/checks | checks:write | Create a new check |
PATCH /v1/public/checks/{id} | checks:write | Update an existing check |
DELETE /v1/public/checks/{id} | checks:delete | Delete a check |
POST /v1/public/checks/{id}/toggle | checks:write | Enable or disable a check |
Alert Endpoints
| Endpoint | Scope Required | Description |
|---|---|---|
GET /v1/public/alerts/email | alerts:read | Get email alert settings |
PATCH /v1/public/alerts/email | alerts:write | Update email alert settings |
POST /v1/public/alerts/email/test | alerts:write | Send a test email |
GET /v1/public/alerts/webhooks | alerts:read | List webhooks |
POST /v1/public/alerts/webhooks | alerts:write | Create a webhook |
POST /v1/public/alerts/webhooks/{id}/test | alerts:write | Send a test alert |
DELETE /v1/public/alerts/webhooks/{id} | alerts:write | Delete a webhook |
Account Creation
| Endpoint | Auth | Description |
|---|---|---|
POST https://app.exit1.dev/oauth/agent-signup | None | An AI agent signs its user up and gets a Bearer token |
Quick Start
- Create an API key with the appropriate scopes
- Include the key in the
X-Api-Keyheader - 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/checksRelated
- Authentication - API key setup
- Scopes - API key permissions
- Rate Limits - Request quotas
- Errors - Error response format
Last updated on
