Uptrends' API | Uptrends

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

Maintenanceperiods API

API Version 3

Documentation of the API

All articles in this category

Accessing the Uptrends API using cURL
Using cURL to access the Uptrends API.
Accessing the Uptrends API using Powershell
Learn how to setup a PowerShell Uptrends' API connection.
Alert Definition API
Using the Alert Definition API, you can manage settings for a specific alert definition. An alert definition is used to define how and to whom an alert is sent. For example, you can configure an alert to be generated when an error occurs for more than 5 minutes, and choose which users should be notified by e-mail and SMS. The Alert Definition API currently only supports enabling and disabling an alert definition with the Active setting.
API changelog
Check out the changes, updates, and improvements for the Uptrends API
API Documentation
Which API will work best for your needs: Version 3, Version 4, or both?
API v3 to v4 upgrade guide
Upgrade guide for switching over your existing Uptrends API v3 setup to API v4. The API v3 will become obsolete in the near future.
API v3 vs v4 object definitions
Overview of differences in object definitions for various monitor types, between Uptrends API v3 and API v4.
API version 4
Our 4th version of the Uptrends API lets you manage and modify Multi-step API and transaction monitors. Our newest version, the API will continue to grow.
Authentication (version 4)
How to register your API account and how authentication works
Maintenance periods in the API
There is a specific set of API methods for manipulating maintenance periods for a monitor or for all monitors in a monitor group. Maintenance period object description The following MaintenancePeriod object is used in the API methods described below: Name Description Data type Id The unique identifier for this maintenance period Integer ScheduleMode OneTime, Daily, Weekly or Monthly Enum StartDateTime A start date and time (only applicable to a One-time scheduled period) DateTime EndDateTime The end date and time of a One-time scheduled maintenance period DateTime StartTime The start time (“HH:mm”, which is 24-hour notation) for a recurring (Daily, Weekly or Monthly) maintenance period String (“HH:mm”) EndTime The end time (“HH:mm”, which is 24-hour notation) for a recurring (Daily, Weekly or Monthly) maintenance period String (“HH:mm”) WeekDay The day of the week for a weekly maintenance period (Sunday/Monday/[…]/Saturday) Enum MonthDay The day number for a monthly maintenance period Int (1-31) MaintenanceType DisableMonitoring (to disable the monitor altogether) or DisableNotifications (monitoring will still occur, but notifications will not be sent) Enum When a maintenance period is returned through the API, all properties will be present, but depending on the ScheduleMode, some fields related to start and end dates/times will not be used.
Monitor API
The endpoints that are part of the Monitor API help you to manage your monitor settings in Uptrends. Monitors are the things you define in Uptrends to describe what needs to be monitored. Typically, a monitor checks a single web page, or a sequence of API calls, or an end-user click path in a web site. The Monitor API has several endpoints that let you create, modify, clone or delete monitor definitions.
Monitor API fields
This article describes the API fields that are relevant for working with the Monitor API. The definition of a Monitor object contains many fields. Some fields apply to all monitors (e.g. the MonitorGuid, Name, CheckInterval, and so on.). However, since different types of monitors require different settings, many fields are only relevant for specific monitor types. Generic monitor fields Field name Description MonitorGuid The monitor’s unique ID.
MonitorCheck API
Monitor check data can be retrieved using the MonitorCheck API endpoints that are part of API v4. Monitor checks are the individual measurements we collect for each monitor, so the MonitorCheck API gives access to that raw data. Once retrieved, that data can be stored in a database for offline analysis, or for audit or backup purposes. The following three endpoints are available: MonitorCheck endpoint Usage /MonitorCheck Returns all Monitor check data in account.
MonitorGroup API
The available API methods for manipulating monitor groups.
Operator API
The available API methods for manipulating operators.
Operator Group API
The available API methods for manipulating operator groups.
Specifying checkpoint regions
How to specify your checkpoints when your account limits you to entire regions.
Uptrends API v3
Use Version 3 of the Uptrends API for modifying monitors (except Multi-step API and Transaction Monitors), get status updates, and retrieving checkpoint data.
Vault API
The Vault is used to store reusable data, often sensitive data like certificates, public keys and username/password combinations. Each entry in the Vault is called a vault item, and vault items are organized in vault sections. Organizing items into different sections is also helpful for restricting access to particular operators and groups. This article describes the available API methods for managing vault items, vault sections and vault section authorizations.For a discussion of Vault usage scenarios, please read the Vault introduction.