Introduction

Welcome to the BlazeMeter API Reference! This reference provides information on accessing our API endpoints to create, run, and update functional and performance test configurations, retrieve functional and performance test results; create, run, and update mock services; manage test data; and create, run, and update API monitoring services.

This API reference uses the following conventions for your convenience:

• Language bindings are available in cURL. You can view the code examples and JSON responses in the dark area to the right.

• Links to the API explorer are provided in the following format: API Explorer: /explorer. To use the API explorer, you must first log in to a.blazemeter.com to establish authentication. If you need an account, signup for a free account (first and last name, and a valid email address are required).

Overview

The tabs at the top correspond to the various APIs provided within BlazeMeter. See BlazeMeter: Getting Started for the list of API tabs that are currently available.

• Functional - How to use the APIs to create, run, and update functional tests and gather the results from API functional and GUI functional tests. This also includes details regarding how to find your supported browsers for private locations, using shared folders, and scheduling your functional tests.
• Performance - How to use the APIs to create, run, and update performance tests (including multi tests) and gather the results from performance tests. This also includes details regarding how to create and update private locations for performance tests, using shared folders, and scheduling your performance tests.
• Mock Services - How to use the APIs to add mock services to Performance and Functional tests, how to build permanent collections of transactions as templates for creating actual mock services, and how to use Taurus and wiremock. You can find the Mock Services docs here
• API Monitoring - How to use the APIs to create, access, and manage your API Monitoring tests, as well as managing details about your account, team, buckets, integrations, and agents. You can find the API Monitoring docs here.
• Test Data - How to use the APIs to create, access, and manage your test data, to generate test data, and to automatically orchestrate the test data in your test environment. You can find the Test Data docs here.

Response Codes (Success and Error)

Response 401 Unauthorized

{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    },
    "api_version": 4,
    "result": null
}

The BlazeMeter API uses conventional HTTP response codes to indicate the success or failure of an API request. Generally, codes in the 2xx range indicate success, codes in the 4xx range indicate client errors (an error that failed to provide the required information such as a missing required parameter), and codes in the 5xx range indicate server errors. The sample response indicates a failure of the API request due to not providing a valid API key.

The BlazeMeter API uses the following response codes: