Uptrends API version 4 is a growing set of API endpoints and methods which let you get information from your monitoring setup and modify it.
In order to make API calls, you have to create an API account. See Register API for the steps.
Accessing API v4 using Swagger
You can explore all API methods on our OpenAPI (Swagger) specification page. 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.
The following API endpoints are currently supported:
The first step you have to take before using the other methods in this API is to register an API account. Please see the article Authentication for detailed steps to register an account and how authentication works.
A set of API methods for managing monitor definitions. Everything you need to automate your monitor management is described in the Monitor API documentation.
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.
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 off-duty schedules for all operators in a group. For more information, please read the Operator Group API documentation.
Alert Definitions API
API methods for managing alert definitions. You can read documentation in the Alert Definition API docs.
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.
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.