Documentation

Get Started

Welcome to Spark Uptime. We're excited to have you here! Please take a moment to review our documentation to help you get started with your new uptime monitoring account. This guide includes helpful information on creating and managing monitors, as well as features like Integrations and SSL/TLS Monitoring. Learn how to make the most of your account!

Create Account Login

Uptime Monitoring

Spark Uptime provides comprehensive monitoring for domains, websites, IP addresses, SSL/TLS, APIs, and network services. Multiple check types allow you to cover every layer of your infrastructure and applications.

Check Types

• Ping: ICMP echo request to verify if a host is online (servers, routers, etc.,).
• Website: HTTP/HTTPS requests to confirm site or API availability and performance.
• Port: TCP port reachability checks for services such as PostgreSQL, Redis, or SMTP.
• Keyword: Loads a page and verifies the presence of a required keyword or phrase.

Create a New Monitor

1. Log in to your account.
2. Click Add Monitor.
3. Select a check type: Ping, Website, Port, Keyword, or Heartbeat.
4. Enter a Nickname for dashboards and notifications.
5. Set the Target (domain, IP address, or URL).
6. Complete any type-specific fields:
   • Keyword: Enter the required phrase to match on the page.
   • Port: Specify the exact TCP port number.
   • Website: Provide a valid URL with http:// or https://. Use https:// for automatic SSL/TLS validation.
7. Click Add New Monitor to save.

Managing Monitors

All monitor management options are available from your account dashboard or the monitor’s detail page.

• Pause: Click Pause next to the monitor in your list, or use the Pause button on the detail page. To resume monitoring, click Resume.
• Rename: On the detail page, click the edit icon, enter a new nickname, and click Save.
• Delete: From the monitor list or detail page, click Delete and confirm. This action is irreversible. To monitor the target again, create a new monitor.
• Reset Incidents: On the detail page, click the three-dot menu, select Reset Events, and confirm. This clears the incident history without deleting the monitor.

Grouping Monitors

Groups allow you to organize large numbers of monitors for faster navigation.

1. Log in and click Add New Group.
2. Enter a group name and click Create.
3. Assign a monitor to a group using the Group column dropdown in the monitor list.
4. To view a specific group, select it from the left-side Groups panel. To return to all monitors, click All Monitors.

Viewing Monitors

• All Monitors: From the main navigation, click Monitors, or use View All at the bottom of your monitor list.
• Live Global Map: From your account, click Live Global Map to view a real-time display of active checks, uptime percentages, and the node currently performing tests. Ideal for full-screen monitoring displays.
• Uptime Reports:
  • All Monitors: View on the primary dashboard.
  • Specific Monitor: Click the monitor nickname or Manage to open the detail page and review historical uptime, response times, and event logs.

Once a monitor is active, Spark Uptime continuously collects response times, HTTP status codes, SSL/TLS validity, and other key metrics. Alerts are sent via your configured integrations so you can respond before customers are impacted.

Next: Configure Integrations

Integrations

Connect Spark Uptime to the tools your team already uses and route alerts where they're most useful.

Create a New Integration

1. Log in to your account and open the Integrations page.
2. Click Create New next to the integration type you want.
3. Enter a Nickname and any required fields.
4. Choose the Notification Type:
   • All (default)
   • Only Down
   • Only Up
5. Click Create to save.

Some integrations use a webhook URL; others require an API key/token. Each integration page includes specific setup instructions.

10+ Available Integrations

• Email
• Slack
• Discord
• Mattermost
• PagerDuty
• Mastodon
• Pushover
• Zapier
• Rocket.Chat
• Webhook
• Pushbullet

View & Manage Integrations

From the dashboard, open Integrations to see all integrations, the number of assigned monitors, and actions.

• Pause: Integrations - Pause.
• Resume: Integrations - Resume.
• Delete: Integrations - Delete - confirm. (irreversible)

Assign an Integration to a Monitor

1. Open the monitor (click the nickname or Manage).
2. In the left panel under Integrations, choose an integration from the dropdown.
3. Click Add Integration.

Once added, that monitor will send alerts using the selected integration and its rules.

Remove an Integration from a Monitor

1. Open the monitor's detail page.
2. Under Integrations, click Remove for the integration you want to detach.

Create Integration See All Integrations

Locations

Checks are performed with our global network of IPv4/IPv6 nodes, verifying incidents from multiple points to ensure accuracy. Our global network includes the following locations:

API

This guide explains how to call each endpoint, required/optional parameters, and expected response fields. Responses default to JSON; pass output=xml for XML.

To obtain your API key, login to your account, click API and then click Enable API.

Endpoints

/v1/account

Description: Returns account details for the authenticated user.

Required parameters:

• key (string) – Your API key.

Optional parameters:

• output (string) – json (default) or xml.

Expected response: Object with:

• status (text) – e.g., active
• account (object) – contains:
  • email (text)
  • limit (integer)
  • up (integer)
  • down (integer)
  • paused (integer)
  • uptime (text, e.g., 99.99%)

/v1/test

Description: Health-check endpoint; returns success with current UTC datetime.

Required parameters:

• key (string)

Optional parameters:

• output (string) – json (default) or xml.

Expected response:

• success (boolean) – true
• date (text) – ISO 8601 UTC datetime

/v1/monitors

Description: Lists monitored targets for the authenticated user.

Required parameters:

• key (string)

Optional parameters:

• output (string) – json (default) or xml.

Expected response: Object with an array monitors; each monitor includes:

• id (integer)
• check_type (text) – e.g., ping, https, http, keyword, port
• status (text) – online, down, or paused
• nickname (text)
• domain_name (text)
• uptime (text) – e.g., 99.99%
• last_responsetime (number)
• last_date (text) – ISO 8601 UTC datetime
• last_location (text) – abbreviated (e.g., nyc)
• last_status (text) – online or down
• created_date (text) – ISO 8601 UTC datetime

/v1/detail

Description: Returns detailed information for a single monitored target.

Required parameters:

• key (string)
• id (integer) – The monitor’s unique identifier.

Optional parameters:

• output (string) – json (default) or xml.

Expected response: Object with detail containing:

• id (integer)
• check_type (text)
• status (text) – online, down, or paused
• nickname (text)
• domain_name (text)
• uptime (text)
• last_responsetime (number)
• last_date (text) – ISO 8601 UTC datetime
• last_location (text) – abbreviated (e.g., nyc)
• last_status (text) – online or down
• created_date (text) – ISO 8601 UTC datetime

Account and Billing

Manage your subscription, payment methods, and invoices from your account.

Access Billing

1. Log in to your account.
2. Click Billing.

Update Billing Information

1. Log in to your account and click Billing.
2. Click Manage Subscription.
3. Click Add Payment Method and enter the required details.
4. On a mobile device, Apple Pay will appear as an available payment method when supported.

Remove a Payment Method

1. Log in to your account and click Billing.
2. Click Manage Subscription.
3. Click the three dots next to the card you want to remove, then click Delete and confirm.

Access Invoices and Receipts

1. Log in to your account and click Billing.
2. Click Manage Subscription.
3. Under Invoice History, click any invoice to view or print.

Cancel Subscription

1. Log in to your account and click Billing.
2. Click the red Cancel Subscription button and confirm.

Open Billing

User-Agent

Spark Uptime is a comprehensive monitoring service that tracks the availability of domains, websites, IP addresses, SSL/TLS, APIs, and more using a global network of 11+ servers. While website and business owners typically monitor their own sites, it is common for individuals to monitor other sites.

Identifier

SparkUptime/1.0

Spark Uptime uses the following User-Agent string for HTTP checks:

Mozilla/5.0 (compatible; SparkUptime/1.0; +https://sparkuptime.com/)

Example log entry

x.x.x.x - - [09/Mar/2025:19:58:18 +0000] "HEAD / HTTP/2.0" 200 0 "-" "Mozilla/5.0 (compatible; SparkUptime/1.0; +https://sparkuptime.com/)"

Blocking via robots.txt

To block the Spark Uptime user agent from accessing your site, add the following lines to your robots.txt file:

User-agent: Spark Uptime
Disallow: /

The system will stop monitoring once it detects this information. Please allow up to 24 hours for detection.

Restoring Monitoring

If you previously blocked Spark Uptime but have since removed the restriction and wish to resume monitoring, create and add a new monitor to your account.

Last Updated: August 16th 2025