How to Create and Delete API Keys
Learn how to create and delete API keys in Kintsugi. See what an API key is, why you need one, how to set an expiration, and how to copy and manage keys safely.Updated last month
What is an API Key?
An API key is a unique identifier used to authenticate requests between a user and a service. It acts as a security token, allowing applications to communicate securely with Kintsugi's services. API keys are crucial for controlling access, preventing unauthorized usage, and ensuring data integrity.
Why Do I Need an API Key?
API Keys serve several important functions:
Authentication & Security: Ensure only authorized users can access Kintsugi’s services.
Access Control: Restrict or grant different levels of access to applications.
Monitoring & Usage Tracking: Keep track of API usage for security and performance insights.
Automation: Enable seamless integration with other tools and services.
Creating an API Key
1. Go to Account Settings
Log in to your Kintsugi account.
2. Navigate to the Configuration tab
On the left side of the app screen, click on the Configuration tab
3. Select API Key
Access the API Key section
4. Create New API
Click New to create a new API key
5. Set an Expiration Date
Select the expiration date for your API (one month, six months, one year or never). Then click, the Save button to proceed.
6. Copy the Generated API key
A new API will be generated and you should copy the key immediately. Kintsugi shows it once and cannot show it again.
Deleting API Keys
Scroll to the right and click the three dots.
Click Delete API Key.
A pop-up will appear asking you if you want to delete the API key because it cannot be undone. Click the Delete button to proceed.
A confirmation message will appear in the bottom of your screen.
Note: API keys are tied to an organization and stay active until either the key or the organization is deleted. You can create multiple keys for periodic rotation.
Important Notes
API keys are associated with an organization and remain active until they are manually deleted or the organization itself is removed.
You can generate multiple API keys, allowing you to rotate them periodically for security purposes.
Keep your API key private and do not share it with unauthorized users to prevent misuse.
By following the steps, you can securely manage API keys and ensure controlled access to Kintsugi’s products and services.
Need Help?
For further concerns, we're always here to help. If you can't find the answer you're looking for, just reach out to us using the chat in the bottom right corner of your screen.