API metacommands

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.

API Metacommands give you information about the API such as what commands and API keys are available on your account.

Commands

api-list_accessible_cmds

Dump a list of all commands this API Key has access to.

Command api-list_accessible_cmds
Values (none)
Result

success
cmd
api-list_accessible_cmds
announcement_list-list_lists
domain-list_domains
dns-list_records

Possible errors (none)

api-list_keys

List all available keys the account has created.

You must have access to all api commands ("*") to use this command.

Command api-list_keys
Values (none)
Result

success
key created comment functions
1234567890ABCDEF 2009-04-29 23:24:57 DreamAdmin *
0987654321ABCDEF 2009-05-11 00:15:56 DreamAdmin Test announcement_list-*,dns-*,domain-*,user-*
ABCDEF1234567890 2010-02-16 13:27:58 DreamAdmin Test 2 domain-list_registrations

Possible errors (none)

See also

 

Did this article answer your questions?

Article last updated .