The Uptrends API version 4 is a comprehensive set of endpoints that allows you to interact with the Uptrends web application using API calls. Use the API to:
- Access real-time monitoring data to track website and web service performance.
- Retrieve performance metrics, uptime statistics, and historical data for analysis and reporting.
- Manage alerts, account settings, user permissions, and monitor configurations.
- Build scripts to create, update, and delete monitors and manage monitoring setup configurations.
For the latest information about API changes and new features, refer to API changelog.
Access the API
To access and use the Uptrends API v4, you must first create an API account. Once created, all Uptrends API endpoints are available on the Uptrends API v4 documentation. This interactive documentation describes all API methods in detail and provides a testing environment where you can try and execute API calls directly.
Additionally, you can use our Swagger specification with Swagger Codegen to generate client code and integrate the Uptrends API into your scripts or applications. To learn more about Swagger and its tools, refer to Swagger.io.
API endpoints
The following API endpoints are currently supported:
Account API
The Account API provides methods for creating, updating, deleting, and managing account information and subscription details. You can access account data including billing information and usage statistics to monitor your Uptrends subscription and resource consumption.
You can access details such as account expiration dates, credit usage per monitor type, and operator counts within your account.
For more information, refer to Account API.
Alert API
The Alert API provides methods for creating, updating, deleting, and managing alert information from specific monitors or monitor groups. You can access alert data including alert timestamps, alert types, error descriptions, and affected monitors to effectively track issues and interruptions of your web services real-time.
For more information, refer to Alert API.
Alert definitions API
The Alert definitions API provides methods for creating, updating, deleting, and managing alert definitions that specify how alerts are sent and who receives them based on escalation levels. You can access details such as alert definition names and their status to ensure that alerts are managed effectively.
For more information, refer to Alert Definition API.
Checkpoint API
The Checkpoint API provides methods for creating, updating, deleting, and managing checkpoint locations or servers that perform the actual monitoring from specific locations.
You can access checkpoint data such as checkpoint name, checkpoint location code, high availability and primary checkpoint status, IPv6 support capabilities, and geographic region information. You can also access server details including IPv4 and IPv6 addresses that you can use for whitelisting in your firewall.
This allows you to check network configurations and monitor your websites and web services across different geographic locations.
Dashboard API
The Dashboard API provides methods for creating, updating, and managing dashboard configurations and their filtering settings. You can modify dashboard displays to create custom monitoring views that match your specific requirements.
You can access details such as dashboard names, descriptions, monitor selections, monitor groups, checkpoint filters, and other display preferences.
Integration API
The Integration API provides methods for creating, updating, deleting, and managing built-in and third-party integrations in your account.
You can access details such as integration names, types, permissions, and other fields to connect to external services for alert notifications, incident management workflows across your existing setup.
Monitor API
The Monitor API provides methods for creating, updating, deleting, and managing monitors in your account. You can configure monitoring setups and track the availability and performance of your websites, web services, APIs regularly.
You can access monitoring data such as monitor name, type, status, check interval, checkpoints, and other fields.
For more information, refer to Monitor API.
MonitorCheck API
The MonitorCheck API provides methods for retrieving detailed monitoring results for each individual check. You can access raw check results and performance metrics to analyze monitoring trends and troubleshoot issues for root cause analysis.
You can access details such as check timestamps, response times, error codes, error conditions, and other performance data.
For more information, refer to MonitorCheck API.
Monitor Group API
The Monitor Group API provides methods for creating, updating, deleting, and managing monitor groups.
You can access details such as monitor group names, status, credit usage per monitor type, associated monitors in the group, and other fields. This allows you to organize monitors and perform bulk operations, such as starting, stopping, or configuring multiple monitors all at once.
For more information, refer to Monitor Group API.
Operator API
The Operator API provides methods for creating, updating, deleting, and managing operators in your Uptrends account. An operator represents an Uptrends account user.
You can access operator data such as operator names, email addresses, phone numbers, language preferences, off-duty schedules, and other settings. This allows you to easily manage users including their permissions, credentials, and schedule preferences.
For more information, refer to Operator API.
Operator Group API
The Operator Group API provides methods for creating, updating, deleting, and managing operator groups. You can organize operators into groups to set the same behavior, access rights, and alert settings. This allows you to organize multiple operators and perform bulk operations, such as setting off-duty schedules and configuring access permissions to members all at once.
For more information, refer to Operator Group API.
OutgoingPhoneNumber API
The OutgoingPhoneNumber API provides methods for retrieving and managing outgoing phone numbers used for phone alert integrations to deliver voice calls and SMS notifications for monitoring alerts.
PrivateLocation API
The PrivateLocation API provides methods for creating, updating, deleting, and managing private locations that allow you to monitor your applications within your internal network that are not accessible through public checkpoints.
You can access details such as private location names, number of servers, server status, checkpoint locations, warning information, associated permissions, and other fields.
For more information, refer to Private Location API.
PublicStatusPage API
The PublicStatusPage API provides methods for creating, updating, deleting, and managing public status pages that are dashboards available to the general public to keep your customers updated on the status of your website.
You can access details such as status page names, descriptions, monitor selections, display configurations, sla status and other fields.
Register API
The Register API allows you to create a new API account to access Uptrends API services. This is the first step before using any other API endpoints.
For detailed steps to register an account and how authentication works, refer to Authentication.
RUM API
The RUM API provides methods for retrieving Real User Monitoring (RUM) metrics and website performance data from actual user interactions. You can access details such as page views, load times, download time, and other fields to track user experience metrics and browser performance data.
ScheduledReport API
The ScheduledReport API provides methods for creating, updating, deleting, and managing the delivery of monitoring reports on a scheduled basis.
You can generate automated reports and send them to specified recipients at regular intervals. You can access details such as report names, scheduling intervals, recipient lists, and others.
SLA API
The SLA API provides methods for creating, updating, deleting, and managing Service Level Agreement (SLA) definitions and retrieving SLA performance metrics for your monitoring setup.
You can access details such as SLA names, SLA targets, uptime commitments, and other metrics to ensure compliance, availability, and performance against business requirements.
Statistics API
The Statistics API provides methods for retrieving statistics information from your Uptrends monitoring data.
You can access historical and real-time statistical information to analyze trends, generate reports, and gain insights into your service performance over specified time periods.
You can access details such as response times, uptime and downtime percentages, error rates, connectivity, performance, and availability metrics.
Status API
The Status API provides methods for retrieving real-time status information about your monitors. You can access the availability and performance of your monitored resources with details such as error level, error descriptions, checkpoint locations or servers, and other fields.
Timezone API
The Timezone API provides methods for managing timezone settings that control how monitoring data and timestamps are displayed within your Uptrends account. It determines the local time format used for reporting monitor check results, alert notifications, scheduled reports, and dashboard displays.
You can access details such as timezone description, daylight saving status, and other fields.
Vault API
The Vault API provides methods for creating, updating, deleting, and managing vault items and sections and their corresponding authorizations. You can securely manage credentials and sensitive information such as vault item types, usernames, passwords, and other fields.
For more information, refer to Vault API.