DNS Monitors: Retrieve All

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

Endpoint

GET /api/dns-monitors/

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

Request

HTTP Request

GET https://uptimekeep.com/api/dns-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/dns-monitors/' \
--header 'Authorization: Bearer {api_key}'

Response

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

Response Example

{
    "data": [
        {
            "id": 1,
            "project_id": 0,
            "name": "Sample",
            "target": "example.com",
            "dns": {
                "A": [
                    {
                        "host": "example.com",
                        "ip": "12.12.12.12"
                    }
                ],
                "CNAME": [],
                "HINFO": [],
                "CAA": [],
                "MX": []
            },
            "notifications": [1],
            "settings": {
                "dns_check_interval_seconds": 300
            },
            "total_checks": 1,
            "total_changes": 0,
            "last_check_datetime": "2024-01-03 01:48:42",
            "next_check_datetime": "2024-01-03 01:49:13",
            "last_change_datetime": null,
            "is_enabled": true,
            "datetime": "2023-12-31 03:54:09",
            "last_datetime": "2024-01-03 00:16:36"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/dns-monitors?&page=1",
        "last": "https://uptimekeep.com/api/dns-monitors?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/dns-monitors?&page=1"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the DNS monitor.
project_id	Integer	ID of the associated project (if applicable).
name	String	Name of the DNS monitor.
target	String	The domain or IP address being monitored.
dns	Object	DNS record types and their respective values (A, CNAME, HINFO, CAA, MX, etc.).
notifications	Array	List of notification handler IDs associated with the monitor.
settings	Object	Configuration settings for the DNS monitor, such as check interval.
total_checks	Integer	Total number of checks performed.
total_changes	Integer	Total number of DNS changes detected.
last_check_datetime	String	Timestamp of the last DNS check (in YYYY-MM-DD HH:MM:SS format).
next_check_datetime	String	Timestamp of the next scheduled DNS check (in YYYY-MM-DD HH:MM:SS format).
last_change_datetime	String	Timestamp of the last DNS change detected (in YYYY-MM-DD HH:MM:SS format), or null if no changes detected.
is_enabled	Boolean	Indicates if the DNS monitor is currently active.
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 DNS 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.