API Access
Use API Access to generate and manage API keys that allow external systems to connect to Rillet securely. API keys are typically used for integrations, automation, or data access through the Rillet API.
Generate an API Key
Follow these steps to create a new API key.
Select Organization Settings.
Select API Access.
Select + Create API Key.
Enter an API Key Name to help identify the key later.
(Optional) Enable Read-only if the key should only allow data retrieval and not modifications.
Select + Create API Key.
After creating the key, the system displays the API key value.
Select the Copy icon next to the API key to copy it to your clipboard.
Save the key in a secure location.
Important 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.
Once saved, the API key becomes active and can be used to authenticate API requests.
Revoke an API Key
Revoking an API key disables it so it can no longer be used to authenticate API requests. The key remains visible in the list for audit and tracking purposes.
Follow these steps to revoke an API key.
Select Organization Settings.
Select API Access.
Locate the API key you want to revoke and select the three-dot menu (⋯) next to the key.
Select Revoke Key.
Once revoked, the API key can no longer be used to authenticate API requests, but it remains visible in the list for reference.
Access API Documentation
You can 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:
API Reference Provides detailed documentation for all available API endpoints, including request parameters, response formats, and authentication requirements.
Guides (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 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
Review the following articles to learn more about system configuration and access management in Rillet.
Last updated