API metacommands

Overview

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

View the following article for instructions on how to connect to the DreamHost API. You will use the instructions in this article to create your API Key.

api-list_accessible_cmds

The api-list_accessible_cmds command lists all commands the API Key used in the command has access to.

For example, the following command would only output commands that the Key 1A2B3C4D5E6F7G8H has been given permissions to access.

These permissions were set when the key was originally created.

https://api.dreamhost.com/?key=1A2B3C4D5E6F7G8H&cmd=api-list_accessible_cmds

api-list_keys

The api-list_keys command lists all API keys the account has created.

You must have an API key with access to all commands ("*") to use this command.

https://api.dreamhost.com/?key=1A2B3C4D5E6F7G8H&cmd=api-list_keys

See also

Did this article answer your questions?

Article last updated PST.

Still not finding what you're looking for?