Skip to main content
PATCH
/
api
/
domains
/
{id}
cURL
curl --request PATCH \
  --url https://domainwarden.app/api/domains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "example.com",
  "label": "My Updated Website",
  "description": "Updated production website",
  "colour": "#10B981",
  "whois_check_interval": "weekly",
  "dns_check_interval": "daily",
  "enabled_dns_records": [
    "A",
    "AAAA",
    "MX",
    "TXT",
    "CNAME"
  ]
}
'
{
  "data": {
    "id": "019a11e5-3072-707a-82b2-91bf8b940e80",
    "label": "My Updated Website",
    "domain": "example.com",
    "description": "Updated production website",
    "colour": "#10B981",
    "provider": "MarkMonitor Inc.",
    "expires_at": "2030-04-12",
    "components": {
      "whois": {
        "is_enabled": true,
        "check_interval": "weekly",
        "check_status": "HEALTHY",
        "latest_check_details": "Initial check completed via RDAP at 2025-10-24 04:18:47 UTC and reported as healthy.",
        "last_checked_at": "2025-10-24T04:18:47.000000Z",
        "next_check_at": null,
        "last_manual_check_at": null,
        "changes_detected_at": null,
        "has_changed_recently": false,
        "was_manually_checked_recently": false
      },
      "dns": {
        "is_enabled": true,
        "check_interval": "daily",
        "check_status": "HEALTHY",
        "latest_check_details": "Initial DNS check completed at 2025-10-23 16:30:49 UTC and reported as healthy.",
        "last_checked_at": "2025-10-23T16:30:49.000000Z",
        "next_check_at": "2025-10-30T16:30:49.000000Z",
        "last_manual_check_at": null,
        "changes_detected_at": null,
        "has_changed_recently": false,
        "was_manually_checked_recently": false,
        "enabled_records": [
          "A",
          "AAAA",
          "MX",
          "TXT",
          "CNAME"
        ]
      },
      "ssl": {
        "is_enabled": true,
        "issuer": null,
        "organization": null,
        "expires_at": null,
        "last_checked_at": null,
        "last_found_invalid_at": null,
        "last_considered_valid_at": null,
        "has_changed_recently": false
      }
    },
    "created_at": "2025-10-23 16:27:04",
    "updated_at": "2025-10-25 14:30:22"
  }
}

Authorizations

​
Authorization
string
header
required

You can obtain your API Token from your Domainwarden account settings.

Path Parameters

​
id
string
required

The ID of the domain.

Body

application/json
​
domain
string

The domain name (cannot be changed after creation, omit this field). Must match the regex /^(?:a-z0-9?.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$/i. Must not be greater than 100 characters.

Example:

"example.com"

​
label
string

optional A friendly label for the domain. Must be between 3 and 40 characters.

Example:

"My Updated Website"

​
description
string | null

optional A description of the domain. Maximum 1000 characters.

Example:

"Updated production website"

​
colour
string | null

optional Hex color code for the domain (e.g., #FF5733 or #F57).

Example:

"#10B981"

​
whois_check_interval
string | null

optional How often to check WHOIS records. Available options depend on subscription plan.

Example:

"weekly"

​
dns_check_interval
string | null

optional How often to check DNS records. Available options depend on subscription plan.

Example:

"daily"

​
enabled_dns_records
string[]

optional DNS record types to monitor.

Example:
["A", "AAAA", "MX", "TXT", "CNAME"]

Response

​
data
object