The Uptrends API allows you to work with your Uptrends account in an automated way: you can build scripts that modify your monitoring setup, or you can access uptime and performance data to do your own number crunching.

We're currently maintaining two API versions:

  • Version 3 has existed for a long time, and contains methods for creating and updating your monitors (except transactions and multi-step API monitors), maintaining monitor groups, retrieving the current status and statistics for your monitors, and downloading information about our checkpoint server locations (including IP addresses).

    Read full documentation on API v3.

  • Version 4 was recently introduced and will continue to grow. You'll need this version if you're looking to make changes to transaction monitors and multi-step API monitors, or duplicate existing monitors of any type.

    Read full documentation on API v4, and explore our OpenAPI specification and Swagger environment.

It's fine to use both APIs side by side, but please be aware that there are some differences in the way you access each version, the terminology used, and the way that data is organized.

Authentication differences

Both versions are REST APIs that require you to supply login credentials using a Basic Authentication HTTP header.

  • For version 3, every time you access the API you'll provide the username (= e-mail address) and password of an Uptrends operator. Any operator can be used, but you'll need Administrator privileges in order to modify data.
  • For version 4, you'll first need to create an API account by providing your Uptrends operator username and password. This will generate separate API credentials, which you can then use for all future API calls. An API account does not expire, so you'll only need to create it once. Remember that an API account is linked to the operator who created it, so it will operate using their privileges.