API/Oneclick commands
NOTE: This documentation is out-dated. Commands listed here are from the old OneClicks API and are no longer valid. The new OneClicks API module is not yet complete. We will update this page once they're all flushed out.
Contents |
One-Click Commands
The oneclick API module manages Easy and Advanced OneClick installs.
Commands
oneclick-list_easy
Values:
(none)
Result:
success domain type stamp blag.dreamhost.com wordpress 2009-01-01 12:34:56
Possible Errors:
none
oneclick-list_advanced
Values:
(none)
Result:
success url type stamp upgradable http://blog.dreamhost.com/ wordpress 2009-01-01 12:34:56 1
Possible Errors:
none
oneclick-install_easy
Values:
domain type, title, email
Result:
success admin_password main_domain token qwerty dreamhost.com gcnaBcD12eFgH34iJkL
Possible Errors:
invalid_type invalid_email invalid_domain cannot_register_domain already_exists (oneclick already exists at this domain) not_your_domain (domain belongs to another user) already_taken (DNS name is in use by another service) not_on_dnsonly oneclick_creation_failed oneclick_install_failed
Possible values for type:
- wordpress
- zenphoto
- phpbb
- drupal
- mediawiki
oneclick-install_advanced
Values:
url (http://example.com/path) type ( phpbb, joomla, gallery, mediawiki, wordpress, webcalendar, poll, zencart, oscommerce, activecollab, phpgedview, pligg, openx, dotproject, moodle, trac ), database (name of a database to install to)
Result:
success token gcnaBcD12eFgH34iJkL
Possible Errors:
no_such_type not_yours no_http_hosting / no_https_hosting / not_fully_hosted (target domain isn't fully hosted) no_such_database / no_database_users / no_database_hostnames
Possible values for type:
- phpbb
- joomla
- gallery
- mediawiki
- wordpress
- webcalendar
- poll
- zencart
- oscommerce
- activecollab
- phpgedview
- pligg
- openx
- dotproject
- moodle
- trac
Note that not all of the advanced oneclicks appear in the Panel as some have been replaced them with preferred alternatives (oscommerce -> zencart, for instance). Please refer to the web panel for the latest apps.
oneclick-upgrade
Note that this performs an upgrade unconditionally -- a oneclick will still be "upgraded" even if its timestamp indicates that it is current.
Values:
url
Result:
success token gcnaBcD12eFgH34iJkL
Possible Errors:
no_such_oneclick not_yours
oneclick-upgrade_all
Values:
type
Result:
success url token http://blag.dreamhost.com/blag1 gcnaBcD12eFgH34iJkL http://blag.dreamhost.com/blag2 gcmaBcD12eFgH34iJkL
Possible Errors:
none
oneclick-list_settings
Values:
domain
Result:
success setting value email support@dreamhost.com language En title My Blag
Possible Errors:
no_such_oneclick not_yours
oneclick-set_settings
Available settings are the ones returned by oneclick-list_settings (which varies from application to application).
Values:
domain setting value
Result:
success
Possible Errors:
no_such_oneclick not_yours no_such_setting invalid_value
oneclick-destroy_easy
Values:
domain
Result:
success database prefix blag_dreamhost_com qwerty
Possible Errors:
no_such_oneclick not_yours
oneclick-destroy_advanced
Values:
url deletefiles (1 -> delete the app, 0 -> leave it in place but forget about it)
Result:
success
Possible Errors:
no_such_oneclick not_yours
