Create Account

API Reference

Use the Spark Uptime API

Call Spark Uptime API endpoints to retrieve account details, test API access, list monitors, and view detailed monitor data.

Enable API access from your account.

Log in to your Spark Uptime account, click API, and then click Enable API to obtain your API key.

Responses default to JSON.

API responses return JSON by default. Pass output=xml to request XML instead.

Authentication is required. Include your API key as the key parameter with each API request.

Base usage

Each endpoint accepts required and optional query parameters. Unless otherwise specified, timestamps are returned as ISO 8601 UTC datetime values.

Required parameter

key — Your Spark Uptime API key.

Optional output format

output — Use json by default or xml for XML responses.

/v1/account

Account details

Returns account details for the authenticated user.

Required parameters

Parameter Type Description
key string Your API key.

Optional parameters

Parameter Type Description
output string json default, or xml.

Expected response

  • status text, for example active
  • account object
  • account.email text
  • account.limit integer
  • account.up integer
  • account.down integer
  • account.paused integer
  • account.uptime text, for example 99.99%
/v1/test

API health check

Health-check endpoint that returns a success response with the current UTC datetime.

Required parameters

Parameter Type Description
key string Your API key.

Optional parameters

Parameter Type Description
output string json default, or xml.

Expected response

  • success boolean, true
  • date text, ISO 8601 UTC datetime
/v1/monitors

List monitors

Lists monitored targets for the authenticated user.

Required parameters

Parameter Type Description
key string Your API key.

Optional parameters

Parameter Type Description
output string json default, or xml.

Expected response

Object with a monitors array. Each monitor includes:

  • id integer
  • check_type text, for example ping, https, http, keyword, or port
  • status text, online, down, or paused
  • nickname text
  • domain_name text
  • uptime text, for example 99.99%
  • last_responsetime number
  • last_date text, ISO 8601 UTC datetime
  • last_location text, abbreviated, for example nyc
  • last_status text, online or down
  • created_date text, ISO 8601 UTC datetime
/v1/detail

Monitor detail

Returns detailed information for a single monitored target.

Required parameters

Parameter Type Description
key string Your API key.
id integer The monitor’s unique identifier.

Optional parameters

Parameter Type Description
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, for example nyc
  • last_status text, online or down
  • created_date text, ISO 8601 UTC datetime
Enable API Access Back to Status Pages