Authorization Using Basic Authentication

API Explorer: /user

To use the BlazeMeter API, pass your BlazeMeter API key using Basic Authentication (Basic Auth) credentials. These credentials contain a Key ID and a Secret Key:

id:secret

For example:

f817e22f1526b048799f75da:7641251982b983cfd92b5a25fa97cd3ee9e21920f21d8b14cd705831826935723f3033f0

If using a tool like Postman, select 'Basic Auth' as the authentication type. From your BlazeMeter API key, enter your api_key_id as the Username and api_key_secret as the Password.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. In the code sample, replace 'api_key_id:api_key_secret' with your credentials.

All API examples used in this documentation use api_key_id and api_key_secret to denote the API Key ID and Secret Key. Just replace these values with your crendentials in each example.

Authorization

curl 'https://a.blazemeter.com/api/v4/user' \
    --user 'api_key_id:api_key_secret'

Response200 OK

{
  "api_version": 4,
  "error": null,
  "result": {
    "id": 123456,
    "email": "my.name@my_email.com",
    "access": 1522676762,
    "login": 1521724222,
    "firstName": "my",
    "lastName": "name",
    "timezone": 0,
    "enabled": true,
    "roles": [
      "user",
      "new-billing",
      "authenticated"
    ]
    }
  }
}

Create the API Key

Use the linked BlazeMeter article to create your API key.

From the User menu (top-right of the screen), click Settings -> API keys (see the Settings column on the left of the screen). Expand the BlazeMeter HELP CENTER tab after selecting the API Keys section for additional information.

Once you have created an API key, the Secret Key that is generated will not reappear after the initial view of it. If you lose this key, then you will have to regenerate the API key to get a new one.