System API

Read Me

This is the documentation for our HTTP, RESTful API.

URL: https://api.rapidspike.com/v1

Entity Relationships

Our system has a hierarchy that must be understood to be able to interact with the API effectively.

This diagram illustrates how an account relates to it's users, assets (servers), websites and subsequent monitors:

Entity Relationship Diagram

  • Accounts have one or many users
  • Accounts have zero, one or many assets (servers)
  • Assets have zero or one Ping Monitor
  • Assets have zero, one or many TCP Monitors
  • Assets have zero, one or many Websites
  • Websites have zero, one or many HTTP Monitors
  • Websites have zero or one Whois Monitor
  • Websites have zero or one SSL Cipher Monitor
  • Websites have zero or one SSL Monitor
  • Websites have zero or one Alexa Monitor
  • Websites have zero or one Moz Monitor
  • Websites have zero or one Safe Browsing Monitor
  • Websites have zero or one Google Analytics Monitor