Skip to main content

Creating an API Key

API Key creation is limited to project admins and owners. Head to your project's dashboard in the web client. Select the settings tab. There'll be a list of options on the left. Choose "API Keys" there to get started.

If you haven't created any API keys yet you'll see an empty list. Select the "New API Key" button.

Fill in the title and choose whether you want the key to have "dev", "ci", "read" or "read/write" access.


Keys used in client-side JavaScript must be set to "read," as they are exposed to the end user. You should only ever use "ci", "read/write," or "dev" in situations where you have authenticated usage of the key, like on the server.

The API key has been created. Make sure you copy the key from this dialog and save it someplace safe and secure. This is the only time you'll be able to see or copy the API key.

Your key is now ready to use. You can delete the key if it becomes compromised or you no longer need it.