Account Settings
      Back to home
      1. Help Center
      2. Admin Portal
      3. Account Settings

      API Keys

      How to Create and Secure an API Key in the Alcatraz Admin Portal

      Creating an API key is required for integrating with the Alcatraz platform securely via the REST API. Follow the steps below to generate, store, and use an API key effectively.

      For more information regarding the REST API, contact your Alcatraz AI account manager.

      Step-by-Step Guide to Create an API Key

       1.   Navigate to the API Keys Section:
      • Log in to the Alcatraz Admin Portal with your credentials.
      • Go to Accounts → Account Settings → API Keys 
       2.   Add a New API Key:
      • Click on the + API Key button.
      • A pop-up window titled "Add an API Key" will appear.
        

       3.   Enter a Description:
      • In the Description field, enter a name or description that helps identify the purpose of this API key (e.g., "Test Key for Integration").
      • Click the Submit button to create the API key.

       4.   Copy the Generated API Key:
      • A new window will pop up confirming the creation of your API key and displaying the key in plain text.

      Important: This is the only time the API key will be shown in plain text. Ensure you copy it immediately and store it in a secure location.

         5.   Acknowledge and Save:

        Click the I have copied the API Key button after securely storing the key. This action confirms that you have saved the key and completes the process.

        Using the API Key

        • Once the key is securely stored, use it in your application or service to authenticate API requests to the Alcatraz platform.
        • Contact your Alcatraz AI account manager to discuss your integration needs.

        Conclusion

        By following this guide, you ensure a secure and efficient process for creating and managing API keys within the Alcatraz Admin Portal. Properly securing your API keys is crucial for maintaining the integrity and security of your systems and data.