Skip to main content

Create API Key

This guide provides detailed instructions on creating an API Key.

Before you begin, please ensure you are signed in.

Create an API Key

  1. Select the Workspace: Start by choosing the appropriate Workspace from the sidebar.
  2. Access API Keys: Click on the "API Keys" (🔑 key icon) in the sidebar to open the API Keys screen within the Workspace Management modal.
  3. Create a New API Key: On the API Keys screen, click the "Create an API-Key" button, represented by a "+" icon.
  4. Enter API Key Name: In the "API Key Name" field, enter a name that clearly identifies the purpose of your API Key. Typically, you can name it according to where it will be used, e.g. "Zapier Integration", "API Gateway (Prod)", etc.
  5. Set Scopes: Choose the necessary permissions for your API Key. You can choose as many scopes as you need for this API Key. See below for more details on what each scope allows you to do.
  6. Set Expiration: You can set an expiration date for your API Key. This is useful to limit the lifespan of your API Key.
  7. Set Bucket: You can optionally associate your API Key with a Bucket. This will limit the API Key to only have access to the data in that specific Bucket.
  8. Backup Your API Key: It is essential to back up your API Key. Store it securely, as it cannot be retrieved once created. Confirm this by ticking the box labeled "I have made a backup of this API key."
  9. Create the API Key: Click the "Create" button to generate your API Key.

Scopes

General

  • Read any data: Allows the API Key to read data from any Bucket.
  • Write any data: Allows the API Key to write data to any Bucket.
  • Decrypt encrypted data: Allows the API Key to decrypt any encrypted data.

Tokens

  • Read tokens: Allows the API Key to view one or more tokens.
  • Create tokens: Allows the API Key to create new tokens.
  • Update tokens: Allows the API Key to update one or more tokens.
  • Delete tokens: Allows the API Key to delete one or more tokens.
  • Manage tokens: Allows the API Key to perform any action (read, create, update, delete) on tokens.

Records

  • Read records: Allows the API Key to view one or more records.
  • Create records: Allows the API Key to create new records.
  • Manage records: Allows the API Key to perform any action (read, create) on records.