|
| 1 | +--- |
| 2 | +title: Flexport |
| 3 | +--- |
| 4 | + |
| 5 | +_This tutorial provides step-by-step instructions on how to rotate a Flexport API key._ |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Generate a new Flexport API key |
| 10 | + |
| 11 | +### Step 1 - Navigate to the [Dashboard](https://portal.flexport.com/) |
| 12 | + |
| 13 | +### Step 2 - Click on 'Settings' at the bottom of the left panel, or from the profile dropdown on the top right. |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +### 3. Navigate to the '[API Tokens](https://portal.flexport.com/settings/api-tokens)' tab. |
| 18 | +#### 3a. Click 'Generate API Token' |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +### 4. Select *only* the permissions that are necessary. |
| 23 | +#### 4a. Give it a descriptive name. |
| 24 | +#### 4b. Click 'Generate'. |
| 25 | + |
| 26 | + |
| 27 | +### 5. You can find your new key under the 'API Tokens' panel. |
| 28 | +#### 5a. Copy the key and store it in a password manager or secure vault. |
| 29 | + |
| 30 | +> Note: You will notice that the status for your new key is set to `ACTIVE`. |
| 31 | +
|
| 32 | +--- |
| 33 | + |
| 34 | +## Revoking a Flexport API key |
| 35 | + |
| 36 | +### Step 1 - Navigate to the [Dashboard](https://portal.flexport.com/) |
| 37 | + |
| 38 | +### Step 2 - Click on 'Settings' at the bottom of the left panel, or from the profile dropdown on the top right. |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +### 3. Navigate to the '[API Tokens](https://portal.flexport.com/settings/api-tokens)' tab. |
| 43 | +#### 3a. Find the token you would like to rotate. |
| 44 | +#### 3b. Click the 'Edit' button. |
| 45 | + |
| 46 | + |
| 47 | +### 4. Click the 'Deactivate token' button. |
| 48 | + |
| 49 | + |
| 50 | +### 5. On the 'Deactivate token' modal, click the 'Yes, Deactivate Token' button. |
| 51 | + |
| 52 | + |
| 53 | +### 6. Go back to the 'API Tokens' tab, and ensure the token status is set to 'INACTIVE'. |
| 54 | + |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Resources |
| 59 | +- [Flexport's Docs](https://developers.flexport.com/tutorials/using-api-credentials) |
0 commit comments