Developer API

API Documentation

Programmatic access to Pulsx monitoring. Create, manage, and query monitors via our REST API.

Pro Plan Required

API access is available exclusively to Pro subscribers. Upgrade to Pro to unlock full API capabilities.

Authentication

All API requests require authentication using a Bearer token in the Authorization header and an active Pro subscription. Your API token is your user ID (found in your account settings).

Authorization: Bearer <your-user-id>

Note: Keep your API token secure. Never expose it in client-side code.

Base URL

https://pulsx.net/api/v1

Endpoints

GET/api/v1/monitors

List all your monitors

Response:

{
  "success": true,
  "data": {
    "monitors": [...],
    "total": 5
  }
}

POST/api/v1/monitors

Create a new monitor

Request Body:

{
  "name": "My Website",
  "url": "https://example.com",
  "type": "http",
  "interval": 5
}

Response:

{
  "success": true,
  "data": {
    "id": "cm...",
    "name": "My Website",
    ...
  }
}

GET/api/v1/monitors/:id

Get monitor details with metrics

Response:

{
  "success": true,
  "data": {
    "id": "cm...",
    "currentState": { "status": "up", ... },
    "metrics": { "uptime30d": 99.95, ... }
  }
}

PATCH/api/v1/monitors/:id

Update a monitor

Request Body:

{
  "name": "Updated Name",
  "interval": 1
}

DELETE/api/v1/monitors/:id

Delete a monitor

Example: Create a Monitor

curl -X POST https://pulsx.net/api/v1/monitors \
  -H "Authorization: Bearer YOUR_USER_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Website",
    "url": "https://example.com",
    "type": "http",
    "interval": 5
  }'

Rate Limits

Free plan: 60 requests per minute
Pro plan: 300 requests per minute

Ready to integrate?

Get Started Free