Take A Look At What OffsiteStatus Can Do For You


System Status Page

Your system status page is the site your customers will go to when your site is acting up. It provides them with a realtime view of your system status and will reassure them that you are working on the issue.

When your site is having an issue you'll simply visit your system status admin page or leverage the OffsiteStatus API to post a status update. You should continue to update your status blog every 30-60 minutes until your system is running normally again.

Screenshot

There are four distinct status levels your system can be in at any given time:

Fully Operational - the default status meaning everything is running

Minor Interruption - to be used when your site is operational, but one aspect may not be functioning correctly

Major Interruption - should be used when the site is not available to your customers

Scheduled Maintenance - automatically turned on/off for scheduled maintenance windows


API Access

This is the documentation for our API:

End Point

The API end point URL is http://yoursubdomain.(a or b).offsitestatus.com/
The "a" or "b" section of the endpoint indicates the data center your status page is hosted in. Look at your URL and make sure you choose the correct data center.

Authentication

All requests require an API token called "auth_token". You can find your API token on your "Edit Your Account" page.

Request Formats

All requests can be sent using JSON.

Response Formats

All responses will be sent using JSON.


API Calls

Post A Status

POST /statuses.json
The request must include the following:
  • status[level] - This is a string consisting of one of the following values ('good','minor','major','scheduled')
  • status[description] - This is a text field explaining the status update.

If you wish to schedule a status, then the following two fields are also required:
  • status[start_time] - This is datetime field. example: '2013-10-10T14:00:00Z'
  • status[end_time] - This is datetime field. example: '2013-10-10T16:00:00Z'

Example Request Body:

{
  "auth_token":"xxtestxx",
  "status":{
      "level":"minor",
      "description":"A few people have reported images not displaying correctly, looking into it."
  }
}

Facebook & Twitter Integration

You have the option to add your system's Facebook & Twitter accounts to your OffsiteStatus page. This will automatically post statuses to your Twitter account & Facebook page, giving you more time to fix the issue.

Social status update

Email Notifications

One huge benefit to your customers is the instant email notifications for status udpates. They can choose to be notified as soon as your system status is updated. This gives them a chance to adjust accordingly if needed.

Email subscription

Customizable URL

Your system status page URL can easily be customized to match your site's URL scheme. Normally, status pages are found at the "status" subdomain of your main domain. To use this scheme for your page you can simply set the custom URL value on your system admin page. Then set up a CNAME record in your DNS records for that subdomain to point to offsitestatus.com.

Example:

So, if you want to setup your OffsiteStatus page at http://status.yourdomain.com:

  1. Go to your OffsiteStaus system admin page and click "Edit This System"
  2. Enter "status.yourdomain.com" into the "Custom URL" field
  3. Create a "CNAME" entry in your DNS configuration that points the "status" subdomain to either
  4. "a.offsitestatus.com" or "b.offsitestatus.com" depending on the data center your site is hosted in.
    If you're unsure which data center your site is hosted in take a look at the URL of your status page. If it looks like "yourpage.a.offsitestatus.com" then you're in the "A" data center. If it looks like "yourpage.b.offsitestatus.com" then you're in the "B" data center.
  5. Wait for the DNS information to propagate across the internet.

Your normal OffsiteStatus URL will continue to work if you customize your URL.

System Status Widgets

Status widgets are a fantastic way to let your customers know instantly if your site is having issues. Instead of them seeing a basic error page and wondering what is wrong, they will see that you are aware of the issue and will be able to view the full status blog for more information.

Status widget

The widget's content is pulled directly from OffsiteStatus, so it'll load just fine when your site is having issues. We give you the code to copy & paste into your HTML.

To fully utilize the widget, we recommend that you add it to your custom 404 & 500 error pages. You can also put this widget on your support page.

Scheduled Maintenance

OffsiteStatus allows you to schedule mainenance windows in order to let your customers know of upcoming downtime. These will be visible on your status blog via a widget to the right of the page:

Upcoming maintenance

Customers that have subscribed to your status updates via email notifications or RSS will be notified as soon as you post the status update, not when the maintenance window begins.

When the scheduled maintenance window begins your OffsiteStatus blog will automatically be updated to show that the site is currently in a scheduled maintance status. When the maintenance window is over the site will automatically put your status back to what it was before the maintenance window began. If your maintenance finishes early you can easily update the status yourself you reflect this.

Multiple System Admins

You can assign as many system admins as you want. This gives each member of your team the ability to update your system status page (via the web or API) anytime they want.

Multiuser