Uptime Monitors: Retrieve All
This documentation entry provides a comprehensive guide to using the "Retrieve All" uptime monitors endpoint, including all relevant details about the request, response, and data structures.
Endpoint
GET /api/monitors/
/api/monitors/Retrieve a list of all uptime monitors associated with your account.
Request
HTTP Request
GET https://uptimekeep.com/api/monitors/Headers
Authorization
String
Bearer token for API authentication.
Query Parameters
page
Integer
(Optional) The page number to retrieve.
1
results_per_page
Integer
(Optional) Number of results per page. Allowed values: 10, 25, 50, 100, 250, 500, 1000.
25
Example of a request:
curl --request GET \
--url 'https://uptimekeep.com/api/monitors/' \
--header 'Authorization: Bearer {api_key}'Response
A successful response returns a JSON object with the list of uptime monitors and associated metadata.
Response Example
Fields
Data Object
id
Integer
Unique identifier for the uptime monitor.
project_id
Integer
ID of the associated project (if applicable).
name
String
Name of the uptime monitor.
type
String
Type of monitor (e.g., "website").
target
String
URL or target being monitored.
port
Integer
Port number being monitored.
settings
Object
Configuration settings for the uptime monitor (see below for details).
ping_servers_ids
Array
List of server IDs used for pinging.
is_ok
Integer
Status of the last check (1 for OK, 0 for Not OK).
uptime
Float
Uptime percentage of the monitored target.
downtime
Float
Downtime percentage of the monitored target.
average_response_time
Integer
Average response time in milliseconds.
total_checks
Integer
Total number of checks performed.
total_ok_checks
Integer
Total number of successful checks.
total_not_ok_checks
Integer
Total number of failed checks.
last_check_datetime
String
Timestamp of the last check (in YYYY-MM-DD HH:MM:SS format).
notifications
Object
Notification settings for the monitor (see below for details).
is_enabled
Boolean
Indicates if the monitor is currently active.
datetime
String
Timestamp when the monitor was created (in YYYY-MM-DD HH:MM:SS format).
Settings Object
check_interval_seconds
Integer
Interval in seconds between checks.
timeout_seconds
Integer
Time in seconds before a check times out.
request_method
String
HTTP method used for the check (e.g., GET, POST).
request_body
String
Body of the request (if applicable).
request_basic_auth_username
String
Username for basic authentication (if required).
request_basic_auth_password
String
Password for basic authentication (if required).
request_headers
Array
Headers to include in the request.
response_status_code
Integer
Expected status code from the response.
response_body
String
Expected response body (if applicable).
response_headers
Array
Expected headers in the response.
Notifications Object
email_is_enabled
Boolean
Indicates if email notifications are enabled.
webhook
String
Webhook URL for notifications (if configured).
slack
String
Slack webhook URL for notifications (if configured).
twilio
String
Twilio credentials for SMS notifications (if configured).
Meta Object
page
Integer
Current page number of the results.
results_per_page
Integer
Number of results per page.
total
Integer
Total number of uptime monitors.
total_pages
Integer
Total number of pages available based on the current query.
Links Object
first
String
URL of the first page of results.
last
String
URL of the last page of results.
next
String
URL of the next page of results (if applicable).
prev
String
URL of the previous page of results (if applicable).
self
String
URL of the current page of results.
Errors
If the request fails, the API will return an error message with an appropriate HTTP status code.
Last updated