> For the complete documentation index, see [llms.txt](https://learn.heeler.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.heeler.com/tenant-admin-guide/access/api-keys.md).

# API Keys

## Creating and Managing API Keys

API keys let you call the Heeler API programmatically.  You can view Heeler's [API documentation here](broken://spaces/bpIar0wyEW7sTUhLxD7O). 

### Where to find it

Administration → **Access** → **API Keys** in the left sidebar.

URL: `https://app.heeler.com/administration/access/api_keys`

### Quick start and authenticating

See the [Generating an API Key documentation](broken://spaces/bpIar0wyEW7sTUhLxD7O/pages/IK9ibmFncBoFatQkMluu).

### Reference

#### Table columns

| Column         | Description                                  |
| -------------- | -------------------------------------------- |
| **Name**       | Descriptive name you gave the key.           |
| **Created At** | When the key was created.                    |
| **Expiration** | When the key will stop working (or "Never"). |
| **Created By** | The user who created the key.                |

#### Actions

* **Create API Key** — generate a new key. The value is shown only at creation time.
* Clicking a row opens detail where you can revoke the key. There is no way to retrieve the value of an existing key — if lost, revoke and create a new one.

### Best practices

* **Name keys descriptively.** 
* **Set an expiration.** Even long-lived service keys should have a reasonable expiry to force rotation.
* **One key per consumer.** Don't share keys across systems — when one needs to rotate, you don't want to break the others.
* **Store in a secret manager.** Never commit API keys to a repo.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://learn.heeler.com/tenant-admin-guide/access/api-keys.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.