API Documentation
Home > Total Uptime APIv2.0 Overview

Total Uptime APIv2.0 Overview

Total Uptime provides a comprehensive API that gives access to every aspect of our platform including products such as Cloud DNS and Networking Solutions as well as Account and product management features. The API is built using RESTful principles. XML and JSON are supported as responses to API calls.

The current API version is 2.0, and as such, we’re at the very beginning of writing documentation for our users. However, for extreme programmers, you can pick apart our management portal at https://manage.totaluptime.com by viewing the source. The entire portal makes use of the API v2.0.

URI


The API can be reached at https://api.totaluptime.com

The API must use HTTPS and supports only modern protocols including TLSv1.1 and TLSv1.2

Authentication


Authentication is currently performed using HTTP Basic Authentication. To use the API, you’ll need to define your username and password. The username is your email address and the password is, well, your password. We strongly encourage you to create a separate user for API use. This will ensure isolation from other users and allow for easy disabling and/or restriction to certain functions (e.g. GET calls only) with the roles and security option.

Response Codes


We return two standard response codes:

Success:               Everything went perfectly

Failed:                   There was an error

No response at all? You most likely hit a non-existent URI. For example, you should not have a trailing slash “/” on your request.

Both responses return further information via XML or JSON. For example, in the case of Failed, you will see a <message> element with the reason. For Success, you will receive results (if requested), or even with a simple update, you will receive the ID of the record you updated in return.

Methods


The API supports these 4 methods: POST, PUT, GET and DELETE.

POST                     For creating new items

PUT                        For modifying existing items

GET                        For retrieving items

DELETE                  For deleting items