> For the complete documentation index, see [llms.txt](https://oten.gitbook.io/kms-support/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://oten.gitbook.io/kms-support/user-guide/publish-your-docs-1/api-platform/manage-api-keys.md).

# Manage API keys

### **What is an API key?**

An API key is a secure credential your application uses to call KMS. Unlike user accounts, API keys are scoped to specific operations, not tied to any individual person, and revocable at any time without affecting other keys or accounts.

<div data-with-frame="true"><figure><img src="/files/SaeysAo3ADn4JEAXMl68" alt=""><figcaption></figcaption></figure></div>

<div align="left" data-with-frame="true"><figure><img src="/files/nqASK5R7iyJZ9AGBZySU" alt="" width="563"><figcaption></figcaption></figure></div>

### **Create a new API key**

1. Click **“Create API Key”**
2. Fill in: **Key Name** (required), **Permissions** (required), **IP Whitelist** (optional — recommended for production), **Description** (optional)
3. Click **Create**

| Permission | What it allows?                 |
| ---------- | ------------------------------- |
| `read`     | Read key details and metadata   |
| `create`   | Create new keys                 |
| `update`   | Update key properties and state |
| `rotate`   | Rotate key versions             |
| `encrypt`  | Encrypt data with keys          |
| d`encrypt` | Decrypt data with keys          |

<div align="left" data-with-frame="true"><figure><img src="/files/sBBnZXviZWEdnoX4sIqL" alt="" width="563"><figcaption></figcaption></figure></div>

### **Save your secret — do this now**

After creation, the system shows your key’s **full secret value once and only once**. Click **COPY** icon before continuing.

<mark style="color:red;">**IMPORTANT**</mark>**:** *Once you close this screen, the secret is gone forever. If you lose it, you must revoke the key and create a new one.*

<div align="left" data-with-frame="true"><figure><img src="/files/n28d3rc7KYhYJaAo6PZ1" alt="" width="563"><figcaption></figcaption></figure></div>

### **Edit and Revoke a key**

Click any key to open the detail panel. You can change: Key Name, IP Whitelist, Permissions, Description. You **cannot** change the Secret Key.

Revoke when a key is no longer needed or may be compromised. Revoked keys cannot be reactivated — create a new one if needed.

<figure><img src="/files/pLSLzw7FelpGAyDQY4e2" alt=""><figcaption></figcaption></figure>