Skip to content

Commit be94829

Browse files
committed
add screenshots to the API key guide
The API key section was text-only, unlike the rest of the FluxDrive docs which illustrate the web UI. Adds four screenshots walking through the flow: the empty API Keys panel, the create dialog, the one-time reveal with its copy-ready curl command, and the populated list used for managing keys. Restructures step 3 so each screenshot sits with the instruction it illustrates, and adds a note that an unused key shows "Never". All values shown are synthetic — the FluxID and every key are fabricated examples captured against a mocked backend, so no real credential appears in the docs.
1 parent 136e401 commit be94829

5 files changed

Lines changed: 15 additions & 6 deletions

File tree

docs/fluxcloud/fluxdrive/api-reference.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,29 @@ Sign in at [cloud.runonflux.com/flux-drive](https://cloud.runonflux.com/flux-dri
3333

3434
#### 3. Generate an API Key
3535

36-
In the FluxDrive web UI, open the **API Keys** panel below your storage usage, then:
36+
Sign in at [cloud.runonflux.com/flux-drive](https://cloud.runonflux.com/flux-drive) and scroll to the **API Keys** panel, below your storage usage.
3737

38-
1. Click **Create key**
39-
2. Give the key a name you'll recognise later (for example `production backup`)
40-
3. Click **Generate**
41-
4. Copy the key — or the ready-made `curl` command — from the dialog that appears
38+
<img src="/.gitbook/assets/fluxdrive-apikeys-panel.png" alt="The API Keys panel in the FluxDrive web UI, with no keys created yet"/>
39+
40+
**1. Click Create key**, then give the key a name you'll recognise later — something that identifies the app or machine that will use it.
41+
42+
<img src="/.gitbook/assets/fluxdrive-apikeys-create.png" alt="The Create API key dialog with a key name entered"/>
43+
44+
**2. Click Generate.** Your new key is displayed along with a ready-to-run `curl` command that already has your FluxID filled in. Use the copy button to the right of either field.
45+
46+
<img src="/.gitbook/assets/fluxdrive-apikeys-reveal.png" alt="The new API key dialog showing the generated key, a ready-to-run curl command, and a warning that the key is shown only once"/>
4247

4348
> ⚠️ **The key is shown only once.** FluxDrive stores only a hash of it, so it cannot be displayed or recovered again after you close that dialog. If you lose a key, revoke it and create a new one.
4449
50+
**3. Store the key somewhere safe** — a password manager, or your deployment's secret store — then click **I've saved it**.
51+
4552
Custom (PRO) plans can be arranged by contacting the Flux team — fill out the [PRO Plan Request Form](https://runonflux.bitrix24.com/pub/form/33_fluxdrive_pro_request_/2xp87g/?view=preview\&preview=inline) for a custom storage allocation.
4653

4754
#### 4. Managing Your Keys
4855

49-
The same panel lists every key on your account, showing its name, first 8 characters, when it was created, and when it was last used — so you can tell which key an integration is actually using before you touch it.
56+
The same panel lists every key on your account, showing its name, first 8 characters, when it was created, and when it was last used — so you can tell which key an integration is actually using before you touch it. A key that has never been used shows **Never**.
57+
58+
<img src="/.gitbook/assets/fluxdrive-apikeys-manage.png" alt="The API Keys panel listing two keys with their name, key prefix, creation date, last-used date, and a revoke button"/>
5059

5160
| Action | How | Effect |
5261
| ------ | --- | ------ |
37.1 KB
Loading
79.8 KB
Loading
43.6 KB
Loading
100 KB
Loading

0 commit comments

Comments
 (0)