Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/assets/images/guides/api_key/api_keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/guides/api_key/create_api_key.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions docs/user_guides/projects/api_key/create_api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ In this guide, you will learn how to create an API key.
### Step 1: Navigate to API Keys

In the _Account Settings_ page you can find the _API_ section showing a list of all API keys.
The table shows each key's name, scope, prefix, creation date, last modification date, and expiration date.
Keys with no expiration show _Never_ in the expiration column.

<p align="center">
<figure>
Expand All @@ -30,9 +32,20 @@ In the _Account Settings_ page you can find the _API_ section showing a list of

### Step 2: Create an API Key

Click `New Api key`, select the required scopes and create it by clicking `Create Api Key`.
Click `New API key`, enter a name, optionally set an expiration, select the required scopes, and click `Create API key`.

Copy the value and save it in a secure location, such as a password manager.
**Expiration options:**

| Option | Description |
| -------- | ------------- |
| No expiration | The key never expires (default). |
| 7 / 30 / 60 / 90 days | The key expires the selected number of days from now. |
| Custom | Pick a specific date using the date picker. |

To change the expiration date of an existing key you must regenerate it — expiration cannot be updated after creation.

Copy the key value and save it in a secure location, such as a password manager.
It will not be shown again.

<p align="center">
<figure>
Expand Down
Loading