fix: API key docs (#6697)

This commit is contained in:
Johannes
2025-10-15 09:12:45 -07:00
committed by GitHub
parent e26a188d1b
commit b78f8d0599
+3 -15
View File
@@ -7,22 +7,12 @@ description: "Here is how you can generate an API key which gives you full acces
## Generate API Key
<Steps>
<Step title="Navigate to 'Organization Settings'">
Go to the Organization Settings page via the menu in the lower left corner.
![Access organization settings](/images/api-reference/organization-settings.webp)
</Step>
<Step title="Access 'API Keys' tab">
Click on the **API Keys** tab in the Organization Settings navigation.
![Access API Keys tab](/images/api-reference/api-keys.webp)
<Step title="Navigate to API Keys">
Click on **API Keys** in the breadcrumbs at the top left corner of the page. Your organization name is a dropdown menu.
</Step>
<Step title="Add a new API key">
Click on the "Add API Key" button to open the creation modal.
![Add API Key button](/images/api-reference/add-api-key.webp)
</Step>
<Step title="Configure your API key">
@@ -33,13 +23,11 @@ description: "Here is how you can generate an API key which gives you full acces
- You can add access to multiple projects by clicking "Add Permission"
3. Configure Organization Access:
- Set appropriate read/write permissions for organization-level access
![Access API Keys tab](/images/api-reference/create-api-key.webp)
</Step>
<Step title="Copy your key">
After creating the key, you'll see the API key value displayed once. Copy it immediately and store it in a secure location. For security reasons, you won't be able to view the complete API key again.
![Copy API Key](/images/api-reference/copy-api-key.webp)
<Note>
Store your API key safely! Anyone who has your API key has access based on the permissions you've granted. For security reasons, the complete API key value cannot be viewed again after creation.
</Note>