Note: Effective 27 August 2025, some fields in the GET and POST /Monitor and GET, PUT, and PATCH /Monitor/{monitorGuid} endpoints will be deprecated. For more information, refer to the API changelog.
Overview
The Monitor API provides a set of endpoints to manage your monitor settings and configuration.
Use cases
Use the Monitor API to:
- Manage monitors and their configuration — create, update, clone, and delete monitors, and access their settings (monitor definition, permissions, and maintenance periods).
- Schedule maintenance periods — plan and manage maintenance periods to prevent false alerts during planned downtime.
- View monitor definitions in bulk — check real-time monitor definitions all at once for analysis and reporting.
Prerequisites
Before using the Monitor API, make sure that you have:
- Uptrends API credentials
- Appropriate permissions to manage monitors in your Uptrends account.
- A basic understanding of your monitoring requirements and the monitor settings that you need to configure.
Monitor API fields
When working with the Monitor API endpoints, the monitor object contains various API fields that may vary depending on the monitor type and configuration. These fields are the MonitorGuid, MonitorType, GenerateAlert, IsActive, and others.
For a complete list of available API fields, refer to the Monitor API fields article.
Monitor API endpoints
The Monitor API provides the following endpoints for managing your monitors:
Manage monitors
| Method | Endpoint | Description |
|---|---|---|
GET |
/Monitor |
Retrieve a list of all monitors and their configuration, with options to filter specific fields. |
POST |
/Monitor |
Create a new monitor using the given configuration. |
GET |
/Monitor/{monitorGuid} |
Retrieve a monitor and its configuration by monitor ID. |
PATCH |
/Monitor/{monitorGuid} |
Update selected fields of a monitor. |
PUT |
/Monitor/{monitorGuid} |
Update all fields of a monitor. |
DELETE |
/Monitor/{monitorGuid} |
Removes the specified monitor from your account. |
POST |
/Monitor/{monitorGuid}/Clone |
Create a duplicate monitor with identical configuration settings (URL, check intervals, alert settings, and others.) but with a new unique monitor ID. The cloned monitor is initially set to inactive, allowing you to modify its configuration before enabling it. |
Manage monitors by monitor group
| Method | Endpoint | Description |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MonitorGroup/ |
Retrieve the GUIDs of monitor groups where the specified monitor is a member. |
GET |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Retrieve monitors and their configurations based on the specified monitor group GUID, with optional field filters. |
POST |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Create a monitor with the given configuration, and add it to the specified monitor group. |
Manage monitor maintenance periods
| Method | Endpoint | Description |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MaintenancePeriod |
Retrieve all scheduled maintenance periods for the specified monitor.
|
PUT |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Update the scheduled maintenance period for the specified monitor.
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod |
Schedule a new maintenance period for the specified monitor.
|
DELETE |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Removes a scheduled maintenance period from the specified monitor.
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod/CleanUp/{beforeDate} |
Removes all one-time maintenance period for the specified monitor before the specified date.
|
Manage monitor permissions
| Method | Endpoint | Description |
|---|---|---|
GET |
/Monitor/{monitorGuid}/Authorizations |
Retrieve all monitor permissions associated with the specified monitor.
|
POST |
/Monitor/{monitorGuid}/Authorizations |
Add monitor permissions to the specified monitor. Granting a permission automatically adds all required permissions for that permission.
|
DELETE |
/Monitor/{monitorGuid}/Authorizations/{authorizationGuid} |
Remove the monitor permission associated with the specified monitor.
|
For detailed request and response formats and interactive API testing, refer to the Uptrends Monitor API documentation.
Troubleshooting
This section covers common HTTP errors and troubleshooting steps for the Monitor API.
Common errors
Common HTTP status codes and their descriptions:
| Status Code | Description |
|---|---|
| 200 | OK — request successful |
| 204 | No content — the request completed successfully and no response was returned. This is for DELETE, PUT, PATCH, and POST requests. |
| 400 | Bad request — invalid request parameters or missing required fields. |
| 401 | Unauthorized — invalid or missing authentication credentials. |
| 403 | Forbidden — permission denied. |
| 404 | Not Found — the specified GUID does not exist. |
| 500 | Internal Server Error — a server-side error occurred. |
General troubleshooting guide
Ensure that you:
- Always validate your request data before sending API calls.
- Use appropriate HTTP methods for each operation.
For further assistance, please reach out to our Support team.
Additional articles
For more details, refer to the following articles:
- Uptrends Monitor API documentation — an interactive API documentation with detailed endpoint specifications.
- Monitor API fields — a list of all available Monitor API fields.
- MonitorCheck API — returns detailed results from individual monitor checks.
- MonitorGroup API - returns detailed information about monitor groups.
- API changelog - for latest API updates and deprecation notices.