Developer Documentation

Complete API documentation for UptimePhunk. Build powerful monitoring solutions with our REST API, GraphQL, webhooks, and official SDKs.

Powerful APIs for every use case

Choose the right API for your needs. From simple REST calls to complex GraphQL queries.

REST API

Complete REST API for managing monitors, notifications, and analytics

50+ endpoints

GraphQL

Advanced GraphQL API for complex queries and real-time subscriptions

Flexible queries

Webhooks

Real-time webhooks for instant notifications to your applications

Event-driven

Authentication

Secure API key and OAuth2 authentication with role-based access

Multiple methods

Quick Start Guide

Get up and running with the UptimePhunk API in minutes.

1

Get your API key

Generate an API key from your dashboard settings

Terminal
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.uptimephunk.com/v1/monitors
2

Create your first monitor

Use the monitors endpoint to create a new website monitor

Terminal
POST /api/monitors
{
  "name": "My Website",
  "url": "https://example.com",
  "type": "website"
}
3

Set up notifications

Configure webhooks or notification channels for alerts

Terminal
POST /api/notifications
{
  "monitorId": "monitor_id",
  "type": "webhook",
  "url": "https://your-app.com/webhook"
}

Official SDKs

Use our official SDKs to integrate UptimePhunk into your applications quickly and easily.

🟨

JavaScript/Node.js

Available

Official SDK for Node.js and browser

🐍

Python

Available

Python SDK with async support

🐘

PHP

Available

PHP SDK with Laravel integration

🐹

Go

Available

Go SDK for high-performance applications

💎

Ruby

Available

Ruby SDK with Rails support

Java

Coming Soon

Java SDK for enterprise applications

🔷

C#

Coming Soon

.NET SDK for Microsoft ecosystem

🍎

Swift

Coming Soon

iOS SDK for mobile applications

Interactive Documentation

Explore our APIs with interactive documentation tools and examples.

Swagger UI

Interactive API documentation with live testing capabilities.

ReDoc

Beautiful, responsive API documentation with search functionality.

Postman Collection

Download our Postman collection for easy API testing.

Complete API Reference

Detailed documentation for every endpoint, parameter, and response.

Core APIs

Monitors API15 endpoints
Notifications API12 endpoints
Analytics API8 endpoints
Teams API6 endpoints

Advanced APIs

Webhooks API5 endpoints
GraphQL APIFlexible queries
Status Pages API4 endpoints
Reports API3 endpoints

Ready to start building?

Get your API key and start integrating UptimePhunk into your applications today.