Domain Names: Retrieve One

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

Endpoint

GET /api/domain-names/{domain_name_id}

Retrieve detailed information about a specific domain name by its unique identifier.

Request

HTTP Request

GET https://uptimekeep.com/api/domain-names/{domain_name_id}

Replace {domain_name_id} with the ID of the domain name 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/domain-names/{domain_name_id}' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object containing detailed information about the specified domain name.

Response Example

{
    "data": {
        "id": 1,
        "project_id": 0,
        "name": "AltumCode.Com",
        "target": "altumcode.com",
        "whois": {
            "start_datetime": "2019-12-15 18:03:36",
            "updated_datetime": "2020-05-24 15:37:15",
            "end_datetime": "2022-12-15 18:03:36",
            "registrar": "NAMECHEAP INC",
            "nameservers": [
                "ns1.digitalocean.com",
                "ns2.digitalocean.com",
                "ns3.digitalocean.com"
            ]
        },
        "whois_notifications": null,
        "ssl": {
            "organization": "Let's Encrypt",
            "common_name": "R3",
            "start_datetime": "2021-06-05 14:40:13",
            "end_datetime": "2021-09-03 14:40:13"
        },
        "ssl_notifications": null,
        "total_checks": 25,
        "last_check_datetime": "2021-07-01 14:42:14",
        "next_check_datetime": "2021-07-04 14:42:15",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2021-03-09 11:30:20"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the domain name.
project_id	Integer	ID of the associated project (if applicable).
name	String	Name of the domain.
target	String	The domain name being monitored.
whois	Object	WHOIS information for the domain (see below for details).
whois_notifications	Array	Notification settings for WHOIS changes.
ssl	Object	SSL certificate information for the domain (see below for details).
ssl_notifications	Array	Notification settings for SSL certificate changes.
total_checks	Integer	Total number of checks performed.
last_check_datetime	String	Timestamp of the last domain check (in YYYY-MM-DD HH:MM:SS format).
next_check_datetime	String	Timestamp of the next scheduled domain check (in YYYY-MM-DD HH:MM:SS format).
is_enabled	Boolean	Indicates if the domain monitoring is currently active.
last_datetime	String	Timestamp of the last update to the domain monitor (in YYYY-MM-DD HH:MM:SS format).
datetime	String	Timestamp when the domain monitor was created (in YYYY-MM-DD HH:MM:SS format).

WHOIS Object

Field	Type	Description
start_datetime	String	Start date of the domain registration.
updated_datetime	String	Last updated date of the WHOIS record.
end_datetime	String	Expiration date of the domain registration.
registrar	String	Registrar managing the domain.
nameservers	Array	List of nameservers associated with the domain.

SSL Object

Field	Type	Description
organization	String	Organization that issued the SSL certificate.
common_name	String	Common name of the SSL certificate.
start_datetime	String	Start date of the SSL certificate.
end_datetime	String	Expiration date of the SSL certificate.

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 domain name ID does not exist.