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.

Accessing API Key Management

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. Access the API Key section

3.1 Click your name at the bottom and select Account.

3.2. In the next page, click Organization API Keys.

3.3. You will see the available API keys in the next page.

Creating and Deleting API Keys

How to Create an API Key

1. Click the "+ New API key" button to proceed.

2. Fill the form API Key Name (optional) and select the expiration date for your API (two weeks, one month, three months, six months, one year or never). Then click, the Create button.

3. A new API will be generated and you should copy it because you will not be able to view it again.

Manage your API Keys

In the same page, you can view a list of your API keys and edit the name or revoke it.

To edit an API Key

1. Scroll to the right and click the three dots. Then, click Edit name.

2. Fill the form with the new API name and click the Save button.

3. A confirmation message will appear in the bottom-right side of your screen.

To Delete an API Key

1. Scroll to the right and click the three dots. Then, click Revoke API key.

2. A pop-up will appear asking you if you want to revoke the API key because it cannot be undone. Click the Revoke key button.

3. A confirmation message will appear at the bottom-right side 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.