API Keys

The API Keys page allows you to generate and manage keys used for accessing the CloudCasa REST API. The CloudCasa API provides a way for you to automate actions such as adding or removing clusters and starting backup and restore jobs. Nearly all actions available through the CloudCasa web UI are also available through the API.

Whenever you send a REST API request from a client device, you need to supply an API key string to authenticate it. Each CloudCasa organization can have up to 10 API keys active. If you need more than 10 keys, please contact support.

Note

Users of the CloudCasa Free Service Plan are limited to generating 1 API key.

Note

Access to the API Keys page is restricted by user role. By default, an Admin role is required. For more details, see Roles.

The CloudCasa API Guide is available at: https://docs.cloudcasa.io/apiguide

Creating an API Key

Take the following steps to create a new API key:

  1. In the API Keys page, click New API Key.

  2. In the API Key sidebar pane, enter the following items:

    Name

    Name of the new API key.

    Description (optional)

    Enter the description which will appear in the list of API keys.

    Roles

    Enter one or more RBAC roles. These roles will be granted to requests using this key.

    Click Generate.

  3. Copy the API key string and store it in a safe place. Click Close.

    Tip

    After closing this dialog, you cannot retrieve the API key string again. If you lose the key string, delete the API key and create a new one.

You will see the new key in the list of API keys, along with its name, description, and the last four characters of the key to help identify it. You can change a key’s name, description, and roles by clicking on its name in the list, or delete a key by clicking on the remove icon.

It is a best practice to use a different key for each application, to restrict each key’s access to the minimum required for the application, to remove all keys that are no longer being used, and to periodically replace keys that are in use with newly generated keys.