Server Monitors: Retrieve All

This documentation entry provides a comprehensive guide to using the "Retrieve All" server monitors endpoint, including all relevant details about the request, response, and data structures.

Endpoint

GET /api/server-monitors/

Retrieve a list of all server monitors associated with your account.

Request

HTTP Request

GET https://uptimekeep.com/api/server-monitors/

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Query Parameters

Parameter	Type	Description	Default Value
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/server-monitors/' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object with the list of server monitors and associated metadata.

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"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/server-monitors?&page=1",
        "last": "https://uptimekeep.com/api/server-monitors?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/server-monitors?&page=1"
    }
}

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).

Meta Object

Field	Type	Description
page	Integer	Current page number of the results.
results_per_page	Integer	Number of results per page.
total	Integer	Total number of server monitors.
total_pages	Integer	Total number of pages available based on the current query.

Links Object

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