Uptime Monitors: Retrieve One

This documentation entry provides a clear and concise guide to using the "Retrieve One" uptime monitor endpoint, including details on how to make the request, the structure of the response...

Endpoint

GET /api/monitors/{monitor_id}

Retrieve detailed information about a specific uptime monitor by its unique identifier.

Request

HTTP Request

GET https://uptimekeep.com/api/monitors/{monitor_id}

Replace {monitor_id} with the ID of the uptime monitor you wish to retrieve.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object containing detailed information about the specified uptime monitor.

Response Example

{
    "data": {
        "id": 1,
        "project_id": 0,
        "name": "Example",
        "type": "website",
        "target": "https://example.com/",
        "port": 0,
        "settings": {
            "check_interval_seconds": 3600,
            "timeout_seconds": 1,
            "request_method": "GET",
            "request_body": "",
            "request_basic_auth_username": "",
            "request_basic_auth_password": "",
            "request_headers": [],
            "response_status_code": 200,
            "response_body": "",
            "response_headers": []
        },
        "ping_servers_ids": [1],
        "is_ok": 1,
        "uptime": 95.5,
        "downtime": 4.5,
        "average_response_time": 500,
        "total_checks": 500,
        "total_ok_checks": 450,
        "total_not_ok_checks": 50,
        "last_check_datetime": "2021-03-25 08:27:07",
        "notifications": {
            "email_is_enabled": 0,
            "webhook": "",
            "slack": "",
            "twilio": ""
        },
        "is_enabled": false,
        "datetime": "2021-02-12 21:54:29"
    }
}

Fields

Data Object

Field	Type	Description
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

Field	Type	Description
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

Field	Type	Description
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).

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code.