Uptrends API version 4 is a growing set of API calls that let you modify your monitoring setup. It currently supports the following APIs:

Register API

Register a new API account for accessing the other methods in this API. Please see the Authentication section below.

Monitor API

A set of API methods for managing monitor definitions.

  • modify an existing transaction monitor;
  • modify an existing multi-step API monitor;
  • clone an existing monitor;
  • delete an existing monitor.
  • modify the maintenance periods for a monitor. For more information on maintenance period modification through the API, please read this documentation.

MonitorCheck API

A set of API methods for getting access to raw monitor check data for each individual check. For more information, read the MonitorCheck API documentation.

Monitor Group API

The Monitor Group API contains methods for adding, updating and deleting monitor groups, and for additional operations on the monitors contained in those groups, such as starting and stopping all monitors. For more information, please read the Monitor Group API documentation.

Operator API

The Operator API is a set of methods for adding, updating and deleting operators. An operator represents a user in an Uptrends account. You can use this API to automate user management in your account. Aside from managing these user logins and settings for each individual operator (including language and communication settings), this API also lets you manage the off-duty schedules for each operator. For more information, please read the Operator API documentation.

Operator Group API

The Operator Group API contains methods for adding, updating and deleting operator groups. You can organize operators into groups, which let you set the same behavior for those operators in terms of access rights and alert settings. The Operator Group API also lets you create Duty Schedules for all operators in a group. For more information, please read the Operator Group API documentation.

Vault API

The Vault API contains methods for adding, updating and deleting items to/from your vault, and maintaining vault section and corresponding authorizations. For more information, read the Vault API documentation and the knowledge base article about the vault.

Checkpoint API

The Checkpoint API lets you retrieve information about the Checkpoint locations/servers that perform the actual monitoring. The Checkpoint server information includes IPv4 and IPv6 addresses that you can use for whitelisting in your firewall. For more information, read the Swagger documentation for the Checkpoint endpoints.

Other APIs

For other operations, you may want to consider API version 3. Read more about choosing between API v3 and API v4.

Accessing API v4 using Swagger

You can explore all API methods on our OpenAPI (Swagger) specification page: https://api.uptrends.com/v4/swagger. That page describes all API methods in detail, and lets you execute each method individually.

Furthermore, you can use our Swagger specification along with Swagger Codegen to generate client code that will get you started in integrating the Uptrends API in your own scripts or applications. For more information about Swagger and Swagger tools, please visit Swagger.io.

Authentication

Each API method requires that you authenticate using an API account, so you'll first need to create one. The /Register method lets you create a new API account. In this example, we'll use the Swagger environment to access the API directly and call the Register method. The API account we're about to create will not expire, so you will only need to do this once.

  1. Go to the Swagger page, and locate and expand the Register POST method.
  2. Click the Try it out button to start creating a request.
  3. In the description field, fill in a simple name, e.g. "My API account". Leave the type field empty.
  4. Click on the Execute button.
  5. Your browser will now ask you to fill in your Uptrends operator login credentials, i.e. the e-mail address and password you normally use to access Uptrends.
  6. After logging in successfully, notice that the Response body contains UserName and Password values: these are the credentials of your new API account.
  7. Please save these credentials, and use them as authentication for all other API calls.
  8. Finally, please remember that this API account is linked to your operator, so it will operate using your privileges.