Domain API commands

Domain API

End-of-Life Warning

This API command will be removed and no longer function on November 2, 2021.

The domain API module commands manage domains and domain registrations.

Commands

domain-list_domains

Dump a list of all hosted domains (not including registrations) on all accounts you have access to.

Command domain-list_domains
Values

(none)

Result

success
account_id domain home type unique_ip hosting_type user path outside_url www_or_not php security fastcgi php_fcgid passenger
1 718apts.com machine.dreamhost.com http 1.2.3.4 full example 718apts.com remove_www mod_php 0 0 1 0 0
1 filesforever.com machine.dreamhost.com http redirect https://files.dreamhost.com/ both_work pcgi4 0 0 1 0 0
1 example.com ps1234.dreamhost.com http full example example.com add_www pcgi5 0 0 1 0 0
1 test.example.com ps5678.dreamhost.com http mirror http://www.example.com/ both_work pcgi5 0 0 1 0 0

Possible values

type : http or https
hosting_type : full or redirect or parked or mirror
www_or_not : Both_work or add_www or remove_www
php : pcgi4 or pcgi5 or mod_php
security : 0 or 1
fastcgi : 0 or 1
php_fcgid : 0 or 1
passenger : 0 or 1

Possible errors

(none)

domain-list_registrations

Dump a list of all domain registrations you have registered with DreamHost, including ones that have expired recently enough that you can still renew them from the panel.

Command domain-list_registrations
Values

(none)

Result

success
account_id domain expires created modified autorenew locked expired ns1 ns2 ns3 ns4 registrant registrant_org registrant_street1 registrant_street2 registrant_city registrant_state registrant_zip registrant_country registrant_phone registrant_fax registrant_email tech tech_org tech_street1 tech_street2 tech_city tech_state tech_zip tech_country tech_phone tech_fax tech_email billing billing_org billing_street1 billing_street2 billing_city billing_state billing_zip billing_country billing_phone billing_fax billing_email admin admin_org admin_street1 admin_street2 admin_city admin_state admin_zip admin_country admin_phone admin_fax admin_email
1 718apts.com 2010-02-05 17:25:06 2009-02-05 17:25:06 2009-02-05 17:25:06 no no no ns1.dreamhost.com ns2.dreamhost.com ns3.dreamhost.com 718apts.com Private Registrant A Happy DreamHost Customer 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 718apts.com@proxy.dreamhost.com 718apts.com Private Registrant A Happy DreamHost Customer 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 718apts.com@proxy.dreamhost.com 718apts.com Private Registrant A Happy DreamHost Customer 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 718apts.com@proxy.dreamhost.com A Happy DreamHost Customer 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 718apts.com@proxy.dreamhost.com

1 example.com 2020-06-15 21:00:00 1997-04-22 21:00:00 2008-04-25 00:04:52 yes no no ns1.dreamhost.com ns2.dreamhost.com ns3.dreamhost.com Example User1 Example User2 1234 Main St Los Angeles CA 12345 US +1.2135551234 example@example.com Example User DreamHost Web Hosting 1234 Main St Los Angeles CA 12345 US +1.2135551234 example@example.com Example User DreamHost Web Hosting 1234 Main St Los Angeles CA 12345 US +1.2135551234 example@example.com DreamHost Web Hosting 1234 Main St CA 12345 US +1.2135551234 example@example.com

1 thebesthostever.com 2009-09-19 15:24:39 2007-09-19 15:24:39 2007-09-19 15:24:39 yes no no ns1.dreamhost.com ns2.dreamhost.com ns3.dreamhost.com thebesthostever.com Private Registrant DreamHost Web Hosting 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 thebesthostever.com@proxy.dreamhost.com thebesthostever.com Private Registrant DreamHost Web Hosting 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 thebesthostever.com@proxy.dreamhost.com thebesthostever.com Private Registrant DreamHost Web Hosting 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 thebesthostever.com@proxy.dreamhost.com DreamHost Web Hosting 417 Associated Rd #324 Brea CA 92821 US +1.2139471032 thebesthostever.com@proxy.dreamhost.com

Possible values

autorenew : yes, no, or ask
locked : yes or no
expired : yes or no

Possible errors

(none)

domain-registration_available

Checks to see if a domain name is available to be registered. Must be a .com, .net .org, or .info domain (and not a subdomain).

Command domain-registration_available
Values

domain

Result

success
available
yes

or

success
available
no

Possible errors

invalid_domain : The domain is not valid or it is a subdomain
invalid_tld : The top level domain is not .com, .net, .org, or .info

See also

Did this article answer your questions?

Article last updated PST.

Still not finding what you're looking for?