BlazeMeter API Reference
Comprehensive reference for BlazeMeter REST APIs.
Overview
BlazeMeter provides REST APIs for automating test execution, managing resources, and integrating with external systems. This skill covers API authentication, identifiers, and all available API endpoints.
Quick Start
- •Overview: Understand BlazeMeter REST API structure
- •Authentication: Configure API key authentication
- •Identifiers: Obtain Workspace ID, Project ID, Test ID, and other identifiers
- •APIs: Use Test Data API, Cloning API, Export API, and Bulk Operations APIs
MCP Tools Integration
BlazeMeter MCP tools provide programmatic access to BlazeMeter, complementing the REST APIs. The MCP tools offer a higher-level interface for common operations:
Available MCP Tools
- •
User Management:
- •
blazemeter_userwith actionread_user- Read current user information - •Returns: User details including default account, workspace, and project
- •
- •
Account Management:
- •
blazemeter_accountwith actionread- Read account information - •
blazemeter_accountwith actionlist- List all accounts - •Required args:
account_id(integer) for read action
- •
- •
Workspace Management:
- •
blazemeter_workspaceswith actionread- Read workspace details - •
blazemeter_workspaceswith actionlist- List all workspaces - •
blazemeter_workspaceswith actionread_locations- Get location lists - •Required args:
workspace_id(integer) for read action,account_id(integer) for list action
- •
- •
Project Management:
- •
blazemeter_projectwith actionread- Read project information - •
blazemeter_projectwith actionlist- List all projects - •Required args:
project_id(integer) for read action,workspace_id(integer) for list action
- •
- •
Test Management:
- •
blazemeter_testswith actionread- Read test details - •
blazemeter_testswith actionlist- List all tests - •
blazemeter_testswith actioncreate- Create new tests - •
blazemeter_testswith actionconfigure_load- Configure load settings - •
blazemeter_testswith actionconfigure_locations- Configure location distribution - •
blazemeter_testswith actionupload_assets- Upload test assets - •Required args:
test_id(integer) orproject_id(integer)
- •
- •
Execution Management:
- •
blazemeter_executionwith actionstart- Start test execution - •
blazemeter_executionwith actionread- Read execution details - •
blazemeter_executionwith actionlist- List all executions - •
blazemeter_executionwith actionread_summary- Get summary report - •
blazemeter_executionwith actionread_errors- Get error report - •
blazemeter_executionwith actionread_request_stats- Get request statistics - •
blazemeter_executionwith actionread_all_reports- Get all reports - •Required args:
test_id(integer) orexecution_id(integer)
- •
- •
Help System:
- •
blazemeter_helpwith actionlist_help_categories- List help categories - •
blazemeter_helpwith actionlist_help_category_content- List help content - •
blazemeter_helpwith actionread_help_info- Read help information - •Required args: Varies by action
- •
When to Use MCP Tools vs REST APIs
- •MCP Tools: Use for high-level operations, automation workflows, and AI agent interactions
- •REST APIs: Use for direct API access, custom integrations, and fine-grained control
Example Workflow
Using MCP Tools for API-like Operations:
- •Use
blazemeter_userwith actionread_userto get default workspace and project IDs - •Use
blazemeter_testswith actionlistto find tests (equivalent to GET /tests API) - •Use
blazemeter_executionwith actionstartto execute tests (equivalent to POST /tests/{testId}/start API) - •Use
blazemeter_executionwith actionread_summaryto get results (equivalent to GET /executions/{executionId}/summary API)
Reference Files
Overview
- •overview.md: BlazeMeter REST APIs, API Overview
Authentication
- •authentication.md: Authorization, API Keys
Identifiers
- •identifiers.md: Get Your Workspace ID, Get the Project ID, Get the Test or Collection ID, Get the Scenario ID, Get the Master ID, Get the Session ID, Get the Location Name
Test Data API
- •test-data-api.md: Test Data API
Cloning API
- •cloning-api.md: Cloning API
Export API
- •export-api.md: Export API
Bulk Operations
- •bulk-operations.md: Service Virtualization Bulk Operations APIs
When to Use Each Reference
- •Overview: When understanding BlazeMeter REST API structure and endpoints
- •Authentication: When configuring API key authentication or authorization
- •Identifiers: When obtaining Workspace ID, Project ID, Test ID, or other identifiers for API calls
- •Test Data API: When using Test Data API for generating and managing test data
- •Cloning API: When cloning services using the Cloning API
- •Export API: When exporting services using the Export API
- •Bulk Operations: When performing bulk operations on Service Virtualization