The Uptime API is a RESTful API that allows you to manage all aspects of your monitoring infrastructure programmatically.
Base URL
All API requests should be made to:
https://uptime.example.com/api/v1
Authentication
All API requests require authentication via an API key passed in the Authorization header. See Authentication for details on generating and using API keys.
Response Format
All responses are returned as JSON. Successful responses include a data field, while error responses include an error field with details about what went wrong. See Errors for the complete error format and status codes.
Available Resources
- Status - Check API health and your account status
- HTTP Monitors - Monitor websites and HTTP endpoints
- DNS Monitors - Monitor DNS records and propagation
- TCP Monitors - Monitor TCP ports and services
- Cron Jobs - Monitor scheduled tasks and cron jobs
- Alerts - Configure alert channels and notifications
- Status Pages - Manage public and private status pages
- Maintenance Windows - Schedule maintenance periods
- Team - Manage team members and permissions
- Invites - Send and manage team invitations
- API Keys - Create and revoke API keys
Rate Limits
API requests are subject to rate limiting based on your plan. See Rate Limits for details on limits and how to handle rate limit errors.