Skip to content
Reseller API
/
/DNS Records

Reseller API (1.0.0)

Feature Overview

The Reseller API provides domain reseller partners with the ability to search, register and manage traditional DNS domains. The API exposes a RESTful interface for domain registration, DNS management, and domain lifecycle operations.

  • Domain Discovery: Search for specific domains or find suggested alternatives, determine pricing, availability and registration details
  • Domain Registration: Register domains with full control over registration period, contacts, and initial DNS configuration
  • DNS Management: Create, update and delete DNS records for your domains
  • Domain Lifecycle: Manage renewals, transfers, contacts, and domain flags through a simple API interface

For access, authentication, environments, and your first request, start with the Quick Start.

For implementation guidance on operations, flags, registration flows, contact management, DNS management, webhooks, and lifecycle operations, see the Implementation Guide.

Overview
Unstoppable Domains (Reseller Engineering)
partnerengineering@unstoppabledomains.com
Languages
Servers
Production
https://api.unstoppabledomains.com/partner/v3
Sandbox
https://api.ud-sandbox.com/partner/v3

Suggestions

Find available domain alternatives based on keywords and preferences.

Operations

Registration & Renewals

Register new domains and manage renewals. Use $preview=true to validate requests and get price quotes before committing.

Operations

Domain Management

Comprehensive domain updates — modify nameservers, DNSSEC, contacts, flags, and DNS records in a single request.

Operations

DNS Records

Create, read, update and delete DNS records for your domains. Also includes DNS metadata, nameserver management, and DNSSEC configuration.

Operations

Get DNS metadata

Request

Retrieve DNS metadata for the specified domain, including the DNS provider and registration status.

Security
bearer
Path
namestringrequired
curl -i -X GET \
  'https://api.unstoppabledomains.com/partner/v3/domains/{name}/dns' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

DNS metadata for domain

Bodyapplication/json
@typestringrequired
Value"unstoppabledomains.com/partner.v3.IcannDomainDnsMetadata"
providerstringrequired
Enum"UD""EXTERNAL""NONE"
registrationobject(DomainRegistrationMinimalResponse)required
registration.​statusstring(DomainRegistrationStatus)
Enum"REGISTERED""REGISTERED_EXTERNAL""PENDING""EXPIRED_GRACE_PERIOD""EXPIRED_REDEMPTION_PERIOD""EXPIRED_PENDING_DELETE""INACTIVE"
registration.​icannobject(DomainRegistrationIcannResponse)
registration.​expirationDatestring
registration.​expirationGracePeriodDatestring
Response
application/json
{
  "@type": "unstoppabledomains.com/partner.v3.IcannDomainDnsMetadata",
  "provider": "UD",
  "registration": {
    "status": "REGISTERED",
    "icann": { … },
    "expirationDate": "string",
    "expirationGracePeriodDate": "string"
  }
}

List DNS records

Request

Retrieve DNS records for the specified domain. Supports filtering by record type and subdomain name, and cursor-based pagination.

Security
bearer
Path
namestringrequired
Query
$cursorstring
typeArray of strings(DnsRecordType)<= 50 items
Items Enum"A""AAAA""ALIAS""CAA""CNAME""DNSKEY""DS""HTTPS""IPSECKEY""MX"
subNameArray of strings<= 50 items
curl -i -X GET \
  'https://api.unstoppabledomains.com/partner/v3/domains/{name}/dns/records?%24cursor=string&type=A&subName=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of DNS records

Bodyapplication/json
@typestringrequired
Value"unstoppabledomains.com/partner.v3.CursorList"
itemsArray of objects(DomainDnsRecordResponse)required
items[].​@typestringrequired
Value"unstoppabledomains.com/partner.v3.DomainDnsRecord"
items[].​subNamestring
items[].​typestring(DnsRecordType)required
Enum"A""AAAA""ALIAS""CAA""CNAME""DNSKEY""DS""HTTPS""IPSECKEY""MX"
items[].​valuesArray of stringsrequired
items[].​ttlnumberrequired
items[].​readonlyobject(DomainDnsRecordReadonlyResponse)
items[].​idstring^rr-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a...required

DNS record ID

Example: "rr-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
nextobject or nullrequired
next.​cursorstring
Response
application/json
{
  "@type": "unstoppabledomains.com/partner.v3.CursorList",
  "items": [
    { … }
  ],
  "next": {
    "cursor": "string"
  }
}

Create a DNS record

Request

Create a new DNS record for the specified domain. Supports all standard DNS record types. Use $preview=true to validate the request without creating the record.

The $upsert option controls behavior when a matching record already exists: REPLACE overwrites, APPEND adds values, DISALLOWED rejects the request.

Security
bearer
Path
namestringrequired
Query
$previewbooleanrequired
Default false
Bodyapplication/jsonrequired
subNamestring

Subdomain name (e.g., "www", "mail"). Omit or leave empty for the apex domain.

typestringrequired

DNS record type. Case-insensitive — values are uppercased automatically.

Enum"A""AAAA""ALIAS""CAA""CNAME""DNSKEY""DS""HTTPS""IPSECKEY""MX"
valuesArray of stringsnon-emptyrequired
ttlnumber[ 1 .. 2147483647 ]required
$upsertstring

Upsert mode for handling conflicts with existing records. Case-insensitive. REPLACE: overwrite existing record values. APPEND: add values to existing record. DISALLOWED: fail if record exists.

Enum"REPLACE""APPEND""DISALLOWED"
$forceCompatibilitybooleanrequired
Default false
curl -i -X POST \
  'https://api.unstoppabledomains.com/partner/v3/domains/{name}/dns/records?%24preview=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "subName": "string",
    "type": "A",
    "values": [
      "string"
    ],
    "ttl": 1,
    "$upsert": "REPLACE",
    "$forceCompatibility": false
  }'

Responses

DNS record creation operation created

Bodyapplication/json
@typestringrequired
Value"unstoppabledomains.com/partner.v3.DomainDnsRecordOperationResult"
operationobject(OperationCheckResponse)required
operation.​@typestringrequired
Value"unstoppabledomains.com/partner.v3.Operation"
operation.​idstring^op-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a...required

Operation ID

Example: "op-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
operation.​statusstringrequired
Enum"PREVIEW""QUEUED""PROCESSING""FAILED""COMPLETED""CANCELLED""AWAITING_UPDATES"
operation.​typestringrequired
Enum"ADMIN_GENERIC""DOMAIN_ADMIN_UPDATE""DOMAIN_RENEW""ACCOUNT_UPDATE""DOMAIN_DNS_RECORD_CREATE""DOMAIN_DNS_RECORD_UPDATE""DOMAIN_DNS_RECORD_DELETE""DOMAIN_DNS_RECORD_BATCH""DOMAIN_DNS_SECURITY_ENABLE""DOMAIN_DNS_SECURITY_DELETE"
operation.​domainstring
operation.​createdAtTimestampnumberrequired
operation.​lastUpdatedTimestampnumberrequired
operation.​validUntilTimestampnumber
operation.​dependenciesArray of any(PlatformOperationDependency)required

List of platform operation dependencies that make up this operation

operation.​dependencies[].​idstringrequired
Example: "plop_abc12345-1234-1234-1234-abc123456789"
operation.​dependencies[].​@typestringrequired
Value"unstoppabledomains.com/partner.v3.PlatformOperation"
operation.​dependencies[].​statusstring(PlatformOperationStatus)required

Status of a platform operation dependency

Enum"PREVIEW""QUEUED""PROCESSING""FAILED""COMPLETED""CANCELLED""AWAITING_UPDATES"
operation.​dependencies[].​typestringrequired
Value"DOMAIN_REGISTER"
Discriminator
operation.​dependencies[].​parametersobjectrequired
operation.​dependencies[].​parameters.​ownerobject(ContactAssignment)required

Reference to an existing or newly created contact

operation.​dependencies[].​parameters.​owner.​newbooleanrequired

Whether this contact is being newly created as part of this operation

operation.​dependencies[].​parameters.​owner.​idstring

Contact ID (present when new is false)

Example: "con_abc12345-1234-1234-1234-abc123456789"
operation.​dependencies[].​parameters.​contactsobject(NonRegistrantContacts)

Non-registrant contact role assignments (admin, billing, tech)

operation.​dependencies[].​parameters.​periodinteger

Registration period in years

Example: 1
operation.​dependencies[].​errorobject(OperationDependencyError)

Error details for a failed operation dependency

Response
application/json
{
  "@type": "unstoppabledomains.com/partner.v3.DomainDnsRecordOperationResult",
  "operation": {
    "@type": "unstoppabledomains.com/partner.v3.Operation",
    "id": "op-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "PREVIEW",
    "type": "ADMIN_GENERIC",
    "domain": "string",
    "createdAtTimestamp": 0,
    "lastUpdatedTimestamp": 0,
    "validUntilTimestamp": 0,
    "dependencies": [ … ]
  }
}

Transfers

Check transfer eligibility and retrieve authorization codes for transferring domains to another registrar.

Operations

Domain Flags

View and manage domain flags that control behavior and security settings such as DNS resolution, transfer locks, WHOIS privacy, and more.

Operations

Domain Contacts

View and update the ICANN-required contacts (owner, admin, tech, billing) assigned to a specific domain.

Operations

Pricing

Retrieve pricing information for domain registration, renewal, transfer, and restoration by domain name or TLD.

Operations

TLDs

Browse available top-level domains (TLDs), their details, and DNS security configuration.

Operations

Contacts

Create and manage ICANN-required contacts for domain registration. Contacts represent individuals or organizations associated with domain roles (owner, admin, tech, billing).

New contacts are automatically sent a verification email upon creation. Contacts can be used in domain registrations immediately, but domains associated with unverified contacts may become unmanageable after a certain period.

Operations

Operations

All asynchronous processes handled by the API are represented as Operations. This includes registering a domain, updating DNS records, renewing a domain, and more.

Operations contain dependencies that represent the individual units of work. Each dependency has its own status, parameters, and result data.

Operations
Webhooks

Hosting

Configure how your domains serve content on the web. Hosting configurations control what happens when someone visits your domain — whether it redirects to another URL or proxies content from another server.

Available hosting types:

  • REDIRECT_301 — Permanent redirect to another URL
  • REDIRECT_302 — Temporary redirect to another URL
  • REVERSE_PROXY — Proxy requests to a backend server

All hosting configurations require SSL certificate provisioning. When a configuration is created or updated, the certificateStatus field will be PENDING until the certificate is issued and active. This process typically completes within a few minutes but may take longer in some cases.

Operations

Account

Manage your account details, authentication tokens, and webhook subscriptions.

Operations