API key best practices

An API key is a unique identifier used to authenticate access to an application or service. Treat it with the same care as you would a password.

Keep your API keys secure

• Do not hard-code API keys in your application code, especially in public repositories.
• Use environment variables or secure secrets management tools to store API keys.
• Avoid sharing your API keys in forums, help centers, or customer support tickets.

Rotate your API keys regularly

Rotating your API keys helps minimize the risk of compromise. Follow these steps to ensure a smooth rotation:

1. Log in to your web interface.
2. Create a new API key while your existing key is still active. This allows you to update your code with the new key before revoking the old one.
3. Delete the old API key once the new one is functioning.

Note: You are limited to only two API keys at a time. This limitation ensures seamless key rotation while maintaining simplicity and security.

API key expiration

API keys for the Rose solver are valid for up to one year. After that, they will no longer provide access. To avoid disruptions, create a new API key before the expiration date and update your systems accordingly.