Update domain

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

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

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

Show child attributes

data.id

string

Example:

"019a11e5-3072-707a-82b2-91bf8b940e80"

data.label

string

Example:

"My Updated Website"

data.domain

string

Example:

"example.com"

data.description

string

Example:

"Updated production website"

data.colour

string

Example:

"#10B981"

data.provider

string

Example:

"MarkMonitor Inc."

data.expires_at

string

Example:

"2030-04-12"

data.components

object

Show child attributes

data.components.whois

object

Show child attributes

data.components.whois.is_enabled

boolean

Example:

true

data.components.whois.check_interval

string

Example:

"weekly"

data.components.whois.check_status

string

Example:

"HEALTHY"

data.components.whois.latest_check_details

string

Example:

"Initial check completed via RDAP at 2025-10-24 04:18:47 UTC and reported as healthy."

data.components.whois.last_checked_at

string

Example:

"2025-10-24T04:18:47.000000Z"

data.components.whois.next_check_at

string

Example:

null

data.components.whois.last_manual_check_at

string

Example:

null

data.components.whois.changes_detected_at

string

Example:

null

data.components.whois.has_changed_recently

boolean

Example:

false

data.components.whois.was_manually_checked_recently

boolean

Example:

false

data.components.dns

object

Show child attributes

data.components.dns.is_enabled

boolean

Example:

true

data.components.dns.check_interval

string

Example:

"daily"

data.components.dns.check_status

string

Example:

"HEALTHY"

data.components.dns.latest_check_details

string

Example:

"Initial DNS check completed at 2025-10-23 16:30:49 UTC and reported as healthy."

data.components.dns.last_checked_at

string

Example:

"2025-10-23T16:30:49.000000Z"

data.components.dns.next_check_at

string

Example:

"2025-10-30T16:30:49.000000Z"

data.components.dns.last_manual_check_at

string

Example:

null

data.components.dns.changes_detected_at

string

Example:

null

data.components.dns.has_changed_recently

boolean

Example:

false

data.components.dns.was_manually_checked_recently

boolean

Example:

false

data.components.dns.enabled_records

string[]

Example:

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

data.components.ssl

object

Show child attributes

data.components.ssl.is_enabled

boolean

Example:

true

data.components.ssl.issuer

string

Example:

null

data.components.ssl.organization

string

Example:

null

data.components.ssl.expires_at

string

Example:

null

data.components.ssl.last_checked_at

string

Example:

null

data.components.ssl.last_found_invalid_at

string

Example:

null

data.components.ssl.last_considered_valid_at

string

Example:

null

data.components.ssl.has_changed_recently

boolean

Example:

false

data.created_at

string

Example:

"2025-10-23 16:27:04"

data.updated_at

string

Example:

"2025-10-25 14:30:22"

Get domain Delete domain

⌘I

API documentation

Domains

User

Authorizations

Path Parameters

Body

Response