Server Monitors: Retrieve One

This documentation entry provides a clear and detailed guide on how to retrieve a specific server monitor using the API, including the necessary parameters, headers, and expected response.

Endpoint

GET /api/server-monitors/{server_monitor_id}

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

Request

HTTP Request

GET https://uptimekeep.com/api/server-monitors/{server_monitor_id}

Replace {server_monitor_id} with the ID of the server 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/server-monitors/{server_monitor_id}' \
--header 'Authorization: Bearer {api_key}'

Response

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

Response Example

{
    "data": {
        "id": 1,
        "project_id": 0,
        "name": "Sample",
        "target": "123.123.123.123",
        "settings": {
            "server_check_interval_seconds": 60
        },
        "cpu_usage": 0.7,
        "ram_usage": 30.65,
        "disk_usage": 16.49,
        "cpu_load_1": 0,
        "cpu_load_5": 0,
        "cpu_load_15": 0,
        "is_enabled": true,
        "total_logs": 100,
        "last_log_datetime": "2024-01-14 02:45:05",
        "datetime": "2024-01-12 02:17:06",
        "last_datetime": "2024-01-14 03:03:35"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the server monitor.
project_id	Integer	ID of the associated project (if applicable).
name	String	Name of the server monitor.
target	String	The IP address or hostname being monitored.
settings	Object	Configuration settings for the server monitor, such as check interval.
cpu_usage	Float	Current CPU usage percentage.
ram_usage	Float	Current RAM usage percentage.
disk_usage	Float	Current disk usage percentage.
cpu_load_1	Float	CPU load average over the last 1 minute.
cpu_load_5	Float	CPU load average over the last 5 minutes.
cpu_load_15	Float	CPU load average over the last 15 minutes.
is_enabled	Boolean	Indicates if the server monitor is currently active.
total_logs	Integer	Total number of logs collected.
last_log_datetime	String	Timestamp of the last log entry (in YYYY-MM-DD HH:MM:SS format).
datetime	String	Timestamp when the monitor was created (in YYYY-MM-DD HH:MM:SS format).
last_datetime	String	Timestamp of the last update to the monitor (in YYYY-MM-DD HH:MM:SS format).

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 404 Not Found if the server monitor ID does not exist.