Breadcrumbs

Self Generating an X-API-key for an user

This article explains how to generate an X-API-key via the Hopstack Dashboard. You can access our API documentation at  https://apidocs.hopstack.io/

Please reach out to the Hopstack Support team to enable API key access via the user interface before proceeding with the steps below.

Steps to generate X-API-key 

  1. Log in to the Hopstack Dashboard. Click on the username.

Screenshot 2025-08-04 at 2.39.52 PM-20250804-091050.png


  1. Select API Keys

Screenshot 2025-08-04 at 2.42.47 PM-20250804-091320.png


  1. Click on the Create API-KEY button.

Screenshot 2025-08-04 at 2.44.31 PM-20250804-091453.png

4. Update your “API Key Name” and click on Create Key.


Screenshot 2025-08-04 at 2.47.28 PM-20250804-091817.png


  1. Once you click on “Create Key”, an API Key will be successfully generated.

Screenshot 2025-08-04 at 2.49.04 PM-20250804-091936.png

You can copy the API Key using the copy icon

Screenshot 2025-08-04 at 2.51.35 PM-20250804-092158.png

🚨 This key will only be shown once. Please copy it now.

Do not share this API key outside of the microservice. Store it securely in your environment variables.


  1. You can delete the API Key using the delete icon.

Screenshot 2025-08-04 at 2.53.09 PM-20250804-092331.png

Once deleted, you can regenerate the API Key using the same process as mentioned in the above steps.

For any questions or concerns, please reach out to the Hopstack support team.