API keys
Each Spice project has two pre-generated API keys, which can be used with Spice SDKs, the HTTP API or the Apache Arrow Flight API.
View API Keys
Navigate to your Spice project in the portal.
Click Settings in the project navigation sidebar.
Under the General section, locate the API Key 1 and API Key 2 fields.
Click on an API key field to copy its value to your clipboard.
Regenerate an API Key
If an API key has been compromised or you need to rotate keys, you can regenerate individual keys. Regenerating a key immediately invalidates the previous key.
Navigate to your Spice project and click Settings.
Scroll to the Danger Zone section.
Click the Regenerate key button next to the key you want to rotate (Regenerate API Key 1 or Regenerate API Key 2).
Confirm the regeneration when prompted.
Copy the new key and update it in your applications.
Regenerating an API key immediately invalidates the old key. Any applications using the old key will lose access. Use the two-key system to rotate keys without downtime: update your applications to use the secondary key first, then regenerate the primary key.
Regenerate via API
API keys can also be regenerated programmatically. See the Management API reference for details.
Last updated
Was this helpful?