Create DNS Monitor

POST /api/dns-monitors

Request BodyCopy Anchor Link

{
  "customerId": "6bfec6f6-245a-47ce-843b-157d97d56f88",
  "name": "Example DNS",
  "hostname": "deinkunde.com",
  "status": "active",
  "checkInterval": 30,
  "timeoutSeconds": 30,
  "allowedCheckCountryCodes": ["DE", "FR"],
  "dnsConfig": {
    "rrtypes": ["A", "AAAA"],
    "matchMode": "exact",
    "expectedValues": {
      "A": ["93.184.216.34"],
      "AAAA": ["2606:2800:220:1:248:1893:25c8:1946"]
    },
    "triggerOn": {
      "resolveError": true,
      "mismatch": true
    }
  }
}

Notes:

• customerId, name, hostname, dnsConfig.rrtypes, dnsConfig.matchMode, and dnsConfig.expectedValues are required.
• customerId accepts either the internal numeric ID or the customer publicId UUID.
• Global supporters cannot create DNS monitors. A readonly or customer-scoped login may create one inside its own customer scope; the monitor is then forced to self_service and refused with selfServiceNotAllowed or selfServiceQuotaReached when the package does not allow it or the quota is used up.
• hostname must be a hostname (no protocol, no path).
• dnsConfig.expectedValues must contain at least one expected value for every RR type listed in dnsConfig.rrtypes.
• allowedCheckCountryCodes (string[], optional)
  • Restricts checks to these ISO-3166-1 alpha-2 country codes.
  • Each entry must be exactly two letters; entries are trimmed, upper-cased and deduplicated before they are stored.
  • Omit the key, send null or send an empty array to drop the restriction on the monitor; a restriction set on the customer itself still applies.
  • The two-letter rule checks the form only: a country code without an active check location is accepted, and the monitor then never runs a check.

Example (cURL)Copy Anchor Link

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X POST \
  "$BASE_URL/api/dns-monitors" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"6bfec6f6-245a-47ce-843b-157d97d56f88","name":"Example DNS","hostname":"deinkunde.com","allowedCheckCountryCodes":["DE","FR"],"dnsConfig":{"rrtypes":["A"],"matchMode":"exact","expectedValues":{"A":["93.184.216.34"]},"triggerOn":{"resolveError":true,"mismatch":true}}}'

Common errorsCopy Anchor Link

• 400 Invalid Customer identifier
• 400 hostname must be a valid hostname (no protocol, no path)
• 400 Expected values are required for RR type <TYPE>
• 400 Bad Request when an allowedCheckCountryCodes entry is not a two-letter country code; the zod issues are in data
• 401 Unauthorized
• 403 Forbidden (global supporter, a customer outside the caller's scope, selfServiceNotAllowed or selfServiceQuotaReached)
• 404 Customer not found

ResponseCopy Anchor Link

Returns the created DNS monitor object. See Error Codes for error responses.