diff --git a/docs/assets/images/guides/api_key/api_keys.png b/docs/assets/images/guides/api_key/api_keys.png index e29fc24c89..a4c3ca57e3 100644 Binary files a/docs/assets/images/guides/api_key/api_keys.png and b/docs/assets/images/guides/api_key/api_keys.png differ diff --git a/docs/assets/images/guides/api_key/create_api_key.gif b/docs/assets/images/guides/api_key/create_api_key.gif index eba792943f..73e6e0a021 100644 Binary files a/docs/assets/images/guides/api_key/create_api_key.gif and b/docs/assets/images/guides/api_key/create_api_key.gif differ diff --git a/docs/user_guides/projects/api_key/create_api_key.md b/docs/user_guides/projects/api_key/create_api_key.md index eb2e5b6d20..3b7a6645d9 100644 --- a/docs/user_guides/projects/api_key/create_api_key.md +++ b/docs/user_guides/projects/api_key/create_api_key.md @@ -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.

@@ -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.