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

# API Access

Use **API Access** to generate and manage the **API keys** that let external systems connect to **Rillet** securely, typically for integrations, automation, or programmatic data access through the Rillet API.

### Generate an API Key

Follow these steps to create a new API key:

1. Select **Organization Settings**.

   <figure><img src="https://612265232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNpXFVFZpTQck3vIrjmHB%2Fuploads%2F3VdDH2zXRy5TVh6Q6pCn%2Fimage.png?alt=media&amp;token=03ad7887-7b6f-4cff-83c5-62fa13a1ef9f" alt=""><figcaption></figcaption></figure>
2. Select **API Access**.
3. Select **+ Create API Key**.

   <figure><img src="https://612265232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNpXFVFZpTQck3vIrjmHB%2Fuploads%2F36dfrDS9wzKAKDqMC7EP%2Fimage.png?alt=media&amp;token=1666817f-2fdf-4a14-ab19-ba6edd49de3a" alt=""><figcaption></figcaption></figure>
4. Enter an **API Key Name** to help identify the key later.
5. **(Optional):** Enable **Read-only** if the key should only allow data retrieval and not modifications.
6. Select **+ Create API Key** to generate the key, which the system then displays.

   <figure><img src="https://612265232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNpXFVFZpTQck3vIrjmHB%2Fuploads%2FtEgjnmdWN0mWX0bbHN3q%2Fimage.png?alt=media&amp;token=e3f3da39-168b-4f04-b0e5-5c02d4d25b10" alt=""><figcaption></figcaption></figure>
7. Select the **Copy icon** next to the API key to copy it to your clipboard.

   <figure><img src="https://612265232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNpXFVFZpTQck3vIrjmHB%2Fuploads%2FrDspmIkCWJ52IScZbLeJ%2Fimage.png?alt=media&amp;token=14d910c0-6f52-446f-a544-99e8a16359ee" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %} <mark style="color:$warning;">**Warning:**</mark>

The full API key is only displayed once for security reasons. After closing the window, you will not be able to view the key again.
{% endhint %}

After completing these steps, save the key in a secure location, where it becomes active immediately and ready to authenticate API requests.

### Revoke an API Key

Take these steps to revoke an API key:

1. Select **Organization Settings**.

   <figure><img src="https://612265232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNpXFVFZpTQck3vIrjmHB%2Fuploads%2Fbg6vVSGwTTeqnp6X0RPP%2Fimage.png?alt=media&amp;token=332c275d-0b62-4994-9ea1-3daba1e4cbb5" alt=""><figcaption></figcaption></figure>
2. Open **API Access**.
3. Locate the API key you want to revoke and select the **three-dot menu (⋯)** next to the key.
4. Select **Revoke Key**.

   <figure><img src="https://612265232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNpXFVFZpTQck3vIrjmHB%2Fuploads%2FpQxbN551DyTnnnQZzkYb%2Fimage.png?alt=media&amp;token=ce47163b-9325-4045-8a50-02df96cfb35f" alt=""><figcaption></figcaption></figure>

Once revoked, the API key can no longer be used to authenticate API requests, but it remains visible in the list for audit and tracking purposes.

### Access the API Documentation

Review Rillet's API documentation to understand how to authenticate requests, explore available endpoints, and follow implementation examples. The following resources provide detailed technical information for developers working with the Rillet API:

| Resource                                                                         | Description                                                                                                                                            |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [**API Reference**](https://docs.api.rillet.com/reference)                       | Provides detailed documentation for all available API endpoints, including request parameters, response formats, and authentication requirements.      |
| [**Guides (Getting Started)**](https://docs.api.rillet.com/docs/getting-started) | Includes step-by-step guides that explain how to start working with the Rillet API, authenticate requests, and implement common integration workflows. |
| [**Changelog**](https://docs.api.rillet.com/changelog)                           | Lists recent API updates, improvements, and changes so you can track new features and modifications.                                                   |

These resources help developers integrate external systems with Rillet and stay informed about API updates.

### See Also

To learn more about system configuration and access management in **Rillet**, review these articles:

* [**Single Sign-On (SSO) and Authentication Options**](/EjmEP4KZ9BVp9j2ho4Mh/settings-and-config/single-sign-on-sso-and-authentication-options.md)
* [**Enable and Use Microsoft Single Sign-On (SSO) in Rillet**](/EjmEP4KZ9BVp9j2ho4Mh/settings-and-config/single-sign-on-sso-and-authentication-options/enable-and-use-microsoft-single-sign-on-sso-in-rillet.md)
* [**User Roles and Permissions Overview**](/EjmEP4KZ9BVp9j2ho4Mh/settings-and-config/user-roles-and-permissions-overview.md)
* [**Manage Access and Roles**](/EjmEP4KZ9BVp9j2ho4Mh/settings-and-config/user-roles-and-permissions-overview/manage-access-and-roles.md)
* [**Audit Logging and Activity History**](/EjmEP4KZ9BVp9j2ho4Mh/reporting/audit-logging-and-activity-history.md)


---

# 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.rillet.com/EjmEP4KZ9BVp9j2ho4Mh/settings-and-config/api-and-developer-access/api-access.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.