DNS Monitors: Retrieve One

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

Endpoint

GET /api/dns-monitors/{dns_monitor_id}

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

Request

HTTP Request

GET https://uptimekeep.com/api/dns-monitors/{dns_monitor_id}

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

Response

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

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"
    }
}

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

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 DNS monitor ID does not exist.