Working with Web API Keys

To add an API key:

1. In the UI, go to Administration | Web API.

2. Click .
   The Add Key dialog is displayed.

2. Enter a name for the new API Key.
3. Enter the owner of the API Key (API Keys are bound to specific users and can only be used by them).

Note:

API's may require specific access levels (required permissions). For information on the required permissions of API's see  Supported Methods.

4. Click .
   Your API key now appears in the list of API keys.

For information on deleting an API key see Deleting an API Key.

To delete an API key:

1. In the UI, go to Administration | Web API.

2. Mark the check-box next to the API key you would like to delete, and click .
   Your API key is deleted.

For information on adding an API key see Adding an API Key.

To enable/disable an API key:

1. In the UI, go to Administration | Web API.

2. In the Key Management area, click Enable/Disable Access.
   An API Key is enabled/disabled.

After being enabled, the API Key details are displayed.