> ## Documentation Index
> Fetch the complete documentation index at: https://developers.opereit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API keys

> Create the API key that authenticates your API requests and your Opereit connectors

An **API key** is how Opereit knows a request comes from your organization. You need one to call the [Opereit API](https://developers.opereit.ai/api-reference/introduction.md), and one for each helpdesk connector, such as [Zoho Desk](https://developers.opereit.ai/connectors/zoho-desk.md) or [Freshdesk](https://developers.opereit.ai/connectors/freshdesk.md).

## What you need

* Access to the [Opereit dashboard](https://dashboard.opereit.ai).

## Create an API key

**1. Open the API Keys page**

Log in to the [Opereit dashboard](https://dashboard.opereit.ai) and go to
**Integrations > API Keys**.

![Opereit dashboard API Keys page listing the existing keys, with a Create key button](https://mintcdn.com/opereit/p363-Oyrzj7O30Gm/images/api-keys/api-keys.png?fit=max\&auto=format\&n=p363-Oyrzj7O30Gm\&q=85\&s=0fec02aef0d5c686bba513c366919afe)

> [!NOTE]
>
> Don't see **API Keys** in the menu? Ask your Opereit contact to enable it
> for your account.

**2. Create the key**

Click **Create key**, enter a **Key name**, and click **Create key** again.

![Create API Key dialog with the key name field filled in](https://mintcdn.com/opereit/p363-Oyrzj7O30Gm/images/api-keys/create-api-key.png?fit=max\&auto=format\&n=p363-Oyrzj7O30Gm\&q=85\&s=1bf30575a27d9d608c1f6c7d5700129c)

Name the key after what will use it, for example `Zoho Desk`, `Freshdesk` or
`Production API`. That way you can revoke one key later without affecting
the others.

**3. Copy the Key ID and Password**

Copy the **ID** and the **Password**. Opereit shows the password only once,
so keep it somewhere safe, such as a password manager. The ID stays visible
on the **API Keys** page.

![New API key showing its name, ID and password, with a warning that the password is shown only once](https://mintcdn.com/opereit/p363-Oyrzj7O30Gm/images/api-keys/api-key-created.png?fit=max\&auto=format\&n=p363-Oyrzj7O30Gm\&q=85\&s=e43df06eab4dcfae15bf64122e5edeff)

> [!WARNING]
>
> The password is shown only once. If you lose it, revoke the key and create
> a new one.

> [!NOTE]
>
> An organization can only have a limited number of active keys. If the dashboard
> says you've reached the maximum, revoke a key you no longer use to make room.

## Use your key

Opereit keys use HTTP Basic Auth: the **Key ID** is the username and the **Key Password** is the password.

> **[The API](https://developers.opereit.ai/api-reference/introduction.md#authentication)**
>
> Send the key with every API request.

> **[Zoho Desk](https://developers.opereit.ai/connectors/zoho-desk.md)**
>
> Enter the key when you install the connector.

> **[Freshdesk](https://developers.opereit.ai/connectors/freshdesk.md)**
>
> Enter the key when you install the connector.

## Manage your keys

* **Replace a key:** create a new key, update it wherever the old one is used, then revoke the old one.
* **Revoke a key:** click **Revoke** on the key in **Integrations > API Keys**. Whatever uses it stops working until you give it a new key.
* **Check usage:** each key shows when it was created and when it was last used.

Keys belong to your organization. A connector or an API request can only see your organization's data.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.