PulseStack™

PulseStack™ REST API Documentation

Comprehensive API Integration for Monitoring Excellence

The PulseStack™ REST API empowers developers to seamlessly integrate uptime monitoring capabilities into their applications. Our robust API delivers comprehensive access to monitoring data, alert configurations, and maintenance scheduling through clean, well-structured endpoints.

Built with modern development practices in mind, the API supports multiple response formats and provides intuitive methods for managing your entire monitoring infrastructure programmatically.

Flexible Response Formats and Data Access

Choose your preferred data format for seamless integration:

  • JSON: https://api.pulsestack.co.uk/v2/methodName?format=json
  • XML: https://api.pulsestack.co.uk/v2/methodName?format=xml
  • JSONP: Include callback parameter for cross-domain requests

For JSONP responses, append callback=yourCallbackFunction to receive data wrapped in your specified function call.

8
Monitor types
8
Alert channels
10
Security checks
14-day
Free trial

Secure Authentication Methods

PulseStack™ implements HTTP Basic Access Authentication with three distinct API key types to match your security requirements:

  • Account-wide keys: Full access to all monitors and API methods within your account
  • Monitor-specific keys: Limited access to individual monitor data, perfect for client-facing implementations
  • Read-only keys: Restricted to data retrieval methods only, ideal for dashboard integrations

Locate your API credentials within the 'My Settings' section of your dashboard. Include your API key in the request body for authentication, or use query parameters for the getMonitors endpoint only.

Usage Limits and Fair Access Policy

To ensure optimal service quality, PulseStack™ enforces reasonable rate limitations:

  • Free accounts: 10 requests per minute
  • Pro accounts: 2 requests per minute per monitor (capped at 5,000 requests/minute)

When limits are exceeded, the API returns a 429 status code alongside helpful headers:

  • X-RateLimit-Limit - Your current rate boundary
  • X-RateLimit-Remaining - Available requests in current period
  • X-RateLimit-Reset - Epoch timestamp when limits reset
  • Retry-After - Recommended wait time before retry

Available API Endpoints and Methods

The PulseStack™ API provides comprehensive functionality through these core endpoints:

  • Account Management: getAccountDetails
  • Monitor Operations: getMonitors, newMonitor, editMonitor, deleteMonitor, resetMonitor
  • Alert Configuration: getAlertContacts, newAlertContact, editAlertContact, deleteAlertContact
  • Maintenance Windows: getMWindows, newMWindow, editMWindow, deleteMWindow
  • Status Pages: getPSPs, newPSP, editPSP, deletePSP

All endpoints utilise POST requests and require proper authentication. Cross-origin resource sharing (CORS) headers are provided for read-only operations using monitor-specific or read-only API keys.

Ready to start monitoring?

Free plan included. No credit card needed.

Get started free