1. Support
  2. Knowledge base
  3. Uptrends' API

Uptrends' API

We’re changing our user interface. Some info may not yet be up to date. Please check From classic to new UI.

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 for your own number crunching.

To get the latest info on changes and new features in the API, please visit the API changelog.

API versions

Uptrends currently offers two API versions:

  • Version 4 is the recommended version for using the Uptrends API. When starting to work with the API, this is the version to go to. Version 4 offers much more functionality than version 3.
  • Version 3 is a legacy version and has far fewer options than version 4 of the API. You should use it only when you already have implemented version 3 APIs and are relying on it, but we recommend switching to version 4 as soon as possible.
While version 3 is still supported, it is not the preferred option and will be deprecated by the end of 2022. Version 3 and 4 will coexist for some time, but as the end of life of version 3 is coming up, we strongly recommend switching to version 4 as soon as possible.

If you are currently actively making use of version 3 of our API, you will need to switch before that version stops being supported by the end of 2022. To prepare for the phasing out of version 3 of our API and assist you in switching over your scripts and processes from using version 3 to version 4, we’ve written an upgrade guide. This article will go over the key differences between the two versions, and guide you through the process of switching API versions.

Both versions are REST APIs that require you to supply login credentials using a Basic Authentication HTTP header. The credentials used for the authentication are different for the versions, see the corresponding documentation for further info.

More information on how to use the API can be found in the knowledge base articles and the API specification environment as listed below.

General API info (version 3 and 4)

Using cURL for API calls

Using Powershell for API calls

Whitelisting of IP addresses

Specifying checkpoint regions

API Version 4

Authentication and creating an API account

OpenAPI Specification (Swagger environment)

Documentation of the API

Monitor API methods

Monitor API fields

MonitorCheck API

MonitorGroup API

Operator API

OperatorGroup API

Alert definition API

Vault API

Maintenanceperiods API

API Version 3

Documentation of the API

By using the Uptrends website, you consent to the use of cookies in accordance with our Cookie Policy.