> For the complete documentation index, see [llms.txt](https://docs.bindplane.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bindplane.com/cli-and-api/api-keys.md).

# API Keys (classic)

Create an API Key to access resources in Bindplane with CLI or REST API.

{% hint style="info" %}
**Availability**

📘 API Keys are available in Bindplane Enterprise (Self-Hosted) and all Bindplane Cloud plans.
{% endhint %}

### Creating an API Key

API Keys can be created from the UI by visiting the Project Settings page, found in the top-right hamburger menu.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FNla6PpzndGhCWR6trTO4%2Fproject-settings.png?alt=media&amp;token=9ddd6cb5-df07-4119-a808-67f49931e7f1" alt=""><figcaption></figcaption></figure>

Navigate to the API Keys section and click "Create API Key".

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2F6G20Zutsrm2IAuxMlZKN%2Fempty-list.png?alt=media&amp;token=349edac3-1c62-4baa-9720-df6d67b556ae" alt=""><figcaption></figcaption></figure>

A modal will appear, allowing you to set an optional Description for the API Key, as well as set an expiration for the API Key. Click "Create" when you are ready.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FVvevNEVbEElCMhamNEIO%2Fcreate-dialog.png?alt=media&amp;token=f0aa5940-cb72-4698-9785-d8d5d3370659" alt=""><figcaption></figcaption></figure>

A window will show you your new API Key. **This will be the only time this key is available to you.** If you do not copy the key now you will have to delete the key and generate another API key.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FjfvvOFYjcdP8SogHuBXs%2Fnew-key-info.png?alt=media&amp;token=af74c4f1-5b0e-45e2-86f5-35a3fe784e91" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Important**

📘 Each user can have up to 25 API keys per project.
{% endhint %}

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FSCXKIbfxYMV8G5o8bJnW%2Fkey-list.png?alt=media&amp;token=ca9a9bce-e5f2-49b4-9b58-18532e4f15e6" alt=""><figcaption></figcaption></figure>

### Audit Trail

Audit logs are generated when API Keys are created or deleted. These are visible by going to the project "Audit Log" in the top right hamburger menu.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FNla6PpzndGhCWR6trTO4%2Fproject-settings.png?alt=media&amp;token=9ddd6cb5-df07-4119-a808-67f49931e7f1" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FO3cmadFfko8bIapXVQzi%2Faudit-log.png?alt=media&amp;token=1ac46adb-47b6-4f13-9917-39478d60c68c" alt=""><figcaption></figcaption></figure>

### Deleting an API Key

Users may remove a key that is no longer needed, or is expired. First navigate to the API Keys section of the Project Settings page.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FSCXKIbfxYMV8G5o8bJnW%2Fkey-list.png?alt=media&amp;token=ca9a9bce-e5f2-49b4-9b58-18532e4f15e6" alt=""><figcaption></figcaption></figure>

Then click the trash can icon <i class="fa-trash">:trash:</i> under Actions on the far right hand side. A dialog will appear to confirm the operation.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2FlFYrJb2Q0UBM83F4XVRv%2Fdelete-prompt.png?alt=media&amp;token=20d83af8-9426-479c-b57c-1fe9c98307c2" alt=""><figcaption></figcaption></figure>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.bindplane.com/cli-and-api/api-keys.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.