Domain Names: Create

This documentation entry provides a clear guide for developers on how to create a new domain name monitor using the API, including the necessary parameters, headers, and expected response.

Endpoint

POST /api/domain-names

Create a new domain name monitor with the specified parameters.

Request

HTTP Request

POST https://uptimekeep.com/api/domain-names

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.
Content-Type	String	Must be set to multipart/form-data for file uploads.

Parameters

Parameter	Type	Required	Description
name	String	Yes	Name of the domain name monitor.
target	String	Yes	The domain name or URL to be monitored.
project_id	Integer	No	ID of the associated project (if applicable).
whois_notifications	Array	No	Array of notification handler IDs for WHOIS changes.
whois_notifications_timing	Integer	No	Timing for WHOIS notifications. Allowed values: 1, 2, 3, 7, 14, 30, 60 (days).
ssl_notifications	Array	No	Array of notification handler IDs for SSL certificate changes.
ssl_notifications_timing	Integer	No	Timing for SSL notifications. Allowed values: 1, 2, 3, 7, 14, 30, 60 (days).
is_enabled	Boolean	No	Enable or disable the domain name monitor.

Example of a request:

curl --request POST \
--url 'https://uptimekeep.com/api/domain-names' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=example.com'

Response

A successful response returns a JSON object containing the unique identifier of the newly created domain name monitor.

Response Example

{
    "data": {
        "id": 1
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the new domain name monitor.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 400 Bad Request if required parameters are missing or invalid.