Documentation menu

Update purchased domain

PATCHhttps://api.instacloud.com/orgs/{orgId}/domains/{domainName}

Token scope: account · org — read-only tokens refused (not a GET).

Turn renewal or the transfer lock on or off for a domain this org bought. A field left out keeps its value. (admin+ for the lock)

Parameters

NameInTypeRequiredDescription
orgIdpathstringyes
domainNamepathstringyes

Request body

application/json

FieldTypeRequiredDescription
autorenewbooleannorenew the domain each year before it expires
lockedbooleannothe registrar transfer lock. Turn it off to move the domain to another registrar; the ICANN lock in `transferLockExpiresAt` still refuses a transfer until it passes

Responses

200

Default Response

FieldTypeRequiredDescription
domainNamestringyes
status"registered" | "attaching" | "active" | "attach_failed" | "detached"yesdetached: every service its hostnames named is gone — attach it again
hostnamesobject[]yes
hostnames.hostnamestringyes
hostnames.state"pending" | "attached" | "active" | "failed"yes
hostnames.reasonstringno
hostnames.servicestring | nullyesthe compute service this hostname serves; each hostname of a domain can serve a different one
registeredAtstring | nullyes
expiresAtstring | nullyes
autorenewbooleanyes
privacybooleanyes
lockedbooleanyesthe registrar transfer lock: while it is on, no other registrar can pull the domain away. Turn it off to move the domain out. What the last write reported, or what registration asked for — nothing reads it back
nameserversstring[]yeswhat the registrar holds. Empty means never written — only a nameserver write fills it in
delegatedbooleanyesthe zone is answered by nameservers InstaCloud cannot write to (custody `foreign`), so nothing published resolves and an attach is refused. A MANAGED delegation reads false: the platform still publishes there
custody"registrar" | "managed" | "foreign"yeswho answers the domain's zone: the registrar's own nameservers, a managed InstaCloud zone (delegated, still platform-published), or somewhere the platform cannot write
transferLockExpiresAtstring | nullyesICANN 60-day lock after registration: no transfer out before this, whatever `locked` says
orderIdstring | nullyes

400

Default Response

FieldTypeRequiredDescription
errorstringyes

403

Default Response

FieldTypeRequiredDescription
errorstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

502

Default Response

FieldTypeRequiredDescription
errorstringyes

503

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown