An API Key A credential that lets programs act on behalf of your Organization through the CloudCannon API, such as a program built with the CloudCannon SDK. An API Key is scoped to the permissions you choose when you create it and belongs to a single Organization. CloudCannon shows the key only once, and you manage your keys on the API Keys page in your Organization Settings. A typed client library for the CloudCannon API that handles authentication and request signing, letting programs read and change content in your Organization without a person logging in through a browser. The CloudCannon SDK (Software Development Kit) authenticates with an Access Key or an API Key, and the CloudCannon CLI is built on top of it. An API (Application Programming Interface) is a set of methods and rules that allow one piece of software to interact with another using code to call specific functions for reading data, triggering actions, or responding to events, rather than a graphical interface. A workspace in CloudCannon that groups together Sites, team members, and shared resources. It is also the unit CloudCannon bills for. You can define permissions for your Organization, controlling the access each team member has to resources on CloudCannon. You can create and be a part of multiple Organizations.API Key
SDK
API
Organization
Create an API Key#
Give your API Key a name that indicates which program will use it, and grant the key only the access that program needs.
To create an API Key:
- In your Organization Settings, open the API Keys page.
- Click the Add API Key button.
- Enter a name for your API Key in the API Key name field.
- Select the permissions you want the key to have.
- Click the Create API Key button.
- Copy your API Key from the Copy API Key screen, then store it somewhere safe.
- Click the I have copied the key button.
CloudCannon will create the API Key and add it to the API Keys page for your Organization.
CloudCannon shows your API Key only once, on the Copy API Key screen. You cannot retrieve it after you leave that screen. If you lose the key, delete it and create a new one.
To use your API Key with the CloudCannon API or SDK, you also need your Organization UUID, which appears at the top of the API Keys page. For more information, please read our documentation on the CloudCannon SDK.
Delete an API Key#
When a program no longer needs access, or when you suspect a key has been exposed, delete it. CloudCannon will reject any request made with a deleted key. Only members of the Owners Permission Group can delete an API Key, even if a Custom Permission Group has permission to create one.
To delete an API Key:
- In your Organization Settings, open the API Keys page.
- Select the key you want to remove to open its page.
- Click the Delete API Key button.
- Confirm the deletion in the Delete this API Key? dialog.
CloudCannon will delete the API Key immediately and reject any further requests made with it.