Documentation menu

List org domains

GEThttps://api.instacloud.com/orgs/{orgId}/domains

Token scope: account · org — read-only tokens allowed.

Every domain the org bought through InstaCloud, including detached ones whose project or service is gone

Parameters

NameInTypeRequiredDescription
orgIdpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
itemsobject[]yes
items.domainNamestringyes
items.status"registered" | "attaching" | "active" | "attach_failed" | "detached"yesdetached: every service its hostnames named is gone — attach it again
items.hostnamesobject[]yes
items.hostnames.hostnamestringyes
items.hostnames.state"pending" | "attached" | "active" | "failed"yes
items.hostnames.reasonstringno
items.hostnames.servicestring | nullyesthe compute service this hostname serves; each hostname of a domain can serve a different one
items.registeredAtstring | nullyes
items.expiresAtstring | nullyes
items.autorenewbooleanyes
items.privacybooleanyes
items.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
items.nameserversstring[]yeswhat the registrar holds. Empty means never written — only a nameserver write fills it in
items.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
items.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
items.transferLockExpiresAtstring | nullyesICANN 60-day lock after registration: no transfer out before this, whatever `locked` says
items.orderIdstring | nullyes

503

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown