The following documentation is officially supported by DreamHost. However, if you find any instructions in this article do not function as intended, it's possible it may be out of date. When in doubt, please contact support for further assistance.
The DNS API module allows you to manage Domain Name Service records.
Commands
dns-list_records
Dump a list of all DNS records for all domains (not including registrations) on all accounts you have access to. Please note that this skips the dreamhosters.com, dreamhost.com, dreamhostps.com, and newdream.net zones.
| Command | dns-list_records |
| Values | (none) |
| Result |
success |
| Possible values | type : A,MX,NS,CNAME,PTR,NAPTR,TXT,SRV,SPF,AAAA, or A6
editable : 0 or 1 |
| Possible errors | (none) |
dns-add_record
Adds a new DNS record to a domain you already have hosted with DreamHost. However, you cannot add dreamhosters.com records. Keep in mind DNS changes may take a while to propagate.
| Command | dns-add_record |
| Values | record : The full name of the record you'd like to add, e.g., testing.groo.com
type : A,CNAME,NS,PTR,NAPTR,SRV,TXT,SPF, or AAAA value : The DNS record's value. comment : Optional comment for this record. |
| Result |
success |
| Possible errors |
no_record |
dns-remove_record
Removes an existing editable DNS record you have with DreamHost. However, you cannot remove dreamhosters.com records. Keep in mind DNS changes may take a while to propagate.
| Command | dns-remove_record |
| Values |
record : The full name of the record you'd like to remove, e.g., testing.groo.com |
| Result |
success |
| Possible errors |
no_record |
