How to Create API Key for your Syncfusion account?

What is a Syncfusion API key?

A Syncfusion API key is a unique authentication token provided by Syncfusion that allows you to securely access its services and tools. With this key, you can enable features like the Syncfusion AI Coding Assistant, which includes an MCP server and a GitHub Copilot extension. These tools help boost productivity, customize components instantly, and accelerate application development.

How to generate an API key on the Syncfusion website?

Creating an API Key on the Syncfusion website is a simple and secure process. Follow these steps:

Step 1: Log in to the website and navigate to the API Key page. This option is available on the My Dashboard page under the My Account section.

Step 2: Click the Generate API Key button to create an API key for your account.

Step 3: A dialog will appear where you can optionally name the key and click Create.

Step 4: After creation, a secure copy window shows the masked key. Click Copy to Clipboard and store the key in a secure place.

Important: For security, the full key will not be displayed again after you close this popup.

Step 5: After closing the popup, you’ll see the Generated API Keys table listing the key’s Name, a masked API key, Created Date (UTC), current Status (e.g., Enabled), and Action options such as Disable or Revoke.

Manage the keys from the table

• Disable: Temporarily turns the key off. You can re‑enable it later.

Buttons:

Yes, Deactivate: Confirms the deactivation; the key’s status will change to “Disabled” in the table.
Cancel: Closes the dialog without making any changes.

The key’s status in the table changes from “Enabled” to “Disabled.” This temporarily suspends access for that key. You can re-enable the key later by selecting the “Enable” option.

• Enable: Turns the key back on, reactivating it so requests using the key start working immediately.

Buttons:

Yes, Activate: Reactivates the key.
Cancel: Closes without changes; the key stays Disabled.

• Revoke: Permanently invalidates the key. You cannot re‑enable a revoked key; generate a new one if needed.

Buttons:

Yes, Revoke: Permanently revokes the key.
Cancel: Close the dialog without changes.

The key is permanently invalidated; all requests using it will fail immediately. Unlike Disable, a revoked key cannot be re-enabled. You must generate a new key if you need access again. The table will reflect the change (the key will be removed).

API Key Limit

Your account can have a maximum of 10 API Keys. If this limit is reached, the portal shows an API Key Limit Reached message and blocks new key creation.

How to proceed:

• Revoke at least one existing key to free a slot.
• Note: Disabling a key does not free the slot; only revoking removes it from the count.