# API key

## Create API key

<div data-full-width="true"><figure><img src="/files/4f93ed70d70e929785afc83f0d8612e52e781cef" alt=""><figcaption></figcaption></figure></div>

1. **Navigate to Settings \[A]**\
   Click the gear icon in the left sidebar to *settings* open it.\
   ▷ The menu *settings* is displayed.
2. **Manage API keys \[B]**\
   Click the tab *API keys*in the top menu bar.\
   ▷ The API key management page opens.
3. **Create new API key \[C]**\
   Click the button **+ API key** in the top-right corner.\
   ▷ A form for entering the API key details is displayed.
4. **Enter API key details**\
   Enter the required information:

   ***Name***: Enter a unique name for the API key.

   ***Validity date***: Select an expiration date if the key should be time-limited.

   ◈ An expired API key can no longer be used and must be renewed to maintain the connection to the API.
5. **Create API key**\
   Click on **Create**, to create the new API key.\
   ▷ The new API key is displayed in the list of API keys.

{% hint style="danger" %}
API keys should only be made available to trusted individuals in order to protect access to your *Eliona*data.
{% endhint %}

## API key information

On the *API keys*list page, you can view the following information for each API key:

**API key name**\
The name of the API key is displayed in the list to allow for clear identification.

**Expiration date**\
The expiration date of the API key is clearly displayed.&#x20;

◈ Once an API key has expired, it can no longer be used, and access to the API is blocked.

**Expired status**\
If an API key has expired, this is indicated by a warning message on the right-hand side next to the key. <img src="/files/da44405adbb061d0639db9f5fb0f4a420f24dde6" alt="" data-size="line">

{% hint style="info" %}
&#x20;An expired API key must be renewed to restore the connection to the API.
{% endhint %}

**Copy API key**\
For each key, there is a **Copy key** button available that can be used to copy the key to the clipboard. <img src="/files/190214d9189f488b9f0834d7f297bb111c17ee73" alt="" data-size="line">\
▷ You can use the copied key to authenticate API requests.

**Delete API key**\
Using the button <img src="/files/1a9ca1f24e3ad238a95facd8793ce5c436f4534d" alt="" data-size="line"> an API key that is no longer needed can be removed.

**Show more information**\
Click on **More information** <img src="/files/7616707c21c3e24282e767bb534201da40861b3a" alt="" data-size="line">to display additional details about the API key.<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.buildings.ability.abb/collection/english-v14/documentation/settings/api-key.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.