Take A Look At What OffsiteStatus Can Do For You

This is the documentation for our API:

End Point

The API end point URL is http://yoursubdomain.offsitestatus.com/

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

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: '2010-11-10T14:00:00Z'
• status[end_time] - This is datetime field. example: '2010-11-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."
  }
}