BlazeMeter API keys

To use the BlazeMeter API, you will need your API key, which can also be used for certain integrations like BlazeMeter's Jenkins plugin.

Generate a new API key

  1. Go to the user drop-down menu at the top right corner of the screen, then click on 'Settings'. You will be transferred to the 'Settings' Panel.

    settings icon

  2. Go to the 'API keys' option under the 'Personal' settings on the left of the screen.

    api keys

  3. There, click on the '+' icon to create a new API key.
    add api key

  4. Give your API key a relevant name that is useful for your reference, and set its expiration period.

    generate api key

  5. Click the "Generate" button.
    Your new API Key ID and API Key Secret is displayed.

    api key id

    Your API Key Secret ("secret key") will only be shown this one time and can never be retrieved again. Make sure to copy the secret key before closing the window. If the secret key is lost, it must be regenerated.

    You've now successfully created a new API key!

Regenerate a new 'Secret' API key for your API key

Every API key has a 'Secret' API key that is visible only to you when you initially create a new API key. In case you forgot your 'Secret' or you simply wish to regenerate it, go to your API keys section, and hover over the relevant API key.api key

You will now see a Regenerate button on the right of the API key. Click the button to regenerate a new 'Secret API key' (and not a new API key).

Your API Key Secret ("secret key") will only be shown this one time and can never be retrieved again. Make sure to copy the secret key before closing the window. If the secret key is lost, it must be regenerated.

Limit the expiration for all API keys under your account

The Account's owner or admin can limit the maximum expiration date for all the API keys of all the users of the Account. That is very useful in case an Account has to take strict security measures.

  1. Go to the user settings drop down menu at the top right corner of the screen.

  2. Click on it and then click 'Settings'. You will be transferred to the 'Settings' Panel.

    default workspace
    api key settings

  3. Go to the 'General Settings' option under the 'Account' settings on the left of the screen.

    api key geenral settings

  4. Use the 'API Keys Expiration Period' panel's drop-down menu to select the maximum expiration period for the account's API keys.
    api key expiration

Want to learn more? Watch our on-demand recording, How to Make JMeter Highly Scalable and More Collaborative With BlazeMeter