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_user with action read_user - Read current user information
- Returns: User details including default account, workspace, and project
Account Management:
blazemeter_account with action read - Read account information
blazemeter_account with action list - List all accounts
- Required args:
account_id (integer) for read action
Workspace Management:
blazemeter_workspaces with action read - Read workspace details
blazemeter_workspaces with action list - List all workspaces
blazemeter_workspaces with action read_locations - Get location lists
- Required args:
workspace_id (integer) for read action, account_id (integer) for list action
Project Management:
blazemeter_project with action read - Read project information
blazemeter_project with action list - List all projects
- Required args:
project_id (integer) for read action, workspace_id (integer) for list action
Test Management:
blazemeter_tests with action read - Read test details
blazemeter_tests with action list - List all tests
blazemeter_tests with action create - Create new tests
blazemeter_tests with action configure_load - Configure load settings
blazemeter_tests with action configure_locations - Configure location distribution
blazemeter_tests with action upload_assets - Upload test assets
- Required args:
test_id (integer) or project_id (integer)
Execution Management:
blazemeter_execution with action start - Start test execution
blazemeter_execution with action read - Read execution details
blazemeter_execution with action list - List all executions
blazemeter_execution with action read_summary - Get summary report
blazemeter_execution with action read_errors - Get error report
blazemeter_execution with action read_request_stats - Get request statistics
blazemeter_execution with action read_all_reports - Get all reports
- Required args:
test_id (integer) or execution_id (integer)
Help System:
blazemeter_help with action list_help_categories - List help categories
blazemeter_help with action list_help_category_content - List help content
blazemeter_help with action read_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_user with action read_user to get default workspace and project IDs
- Use
blazemeter_tests with action list to find tests (equivalent to GET /tests API)
- Use
blazemeter_execution with action start to execute tests (equivalent to POST /tests/{testId}/start API)
- Use
blazemeter_execution with action read_summary to 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
1---2name: blazemeter-api-reference3description: Comprehensive reference for BlazeMeter REST APIs, including authentication, identifiers, and API endpoints. Use when working with BlazeMeter APIs for (1) Understanding BlazeMeter REST API structure, (2) Authenticating API requests, (3) Obtaining identifiers (Workspace ID, Project ID, Test ID, etc.), (4) Using Test Data API, (5) Using Cloning API, (6) Using Export API, (7) Using Service Virtualization Bulk Operations APIs, or any other API tasks.4metadata:5 source: https://skillmd.com/skills/blazemeter/blazemeter-api-reference6---78# BlazeMeter API Reference910Comprehensive reference for BlazeMeter REST APIs.1112## Overview1314BlazeMeter 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.1516## Quick Start17181. **Overview**: Understand BlazeMeter REST API structure192. **Authentication**: Configure API key authentication203. **Identifiers**: Obtain Workspace ID, Project ID, Test ID, and other identifiers214. **APIs**: Use Test Data API, Cloning API, Export API, and Bulk Operations APIs2223## MCP Tools Integration2425BlazeMeter MCP tools provide programmatic access to BlazeMeter, complementing the REST APIs. The MCP tools offer a higher-level interface for common operations:2627### Available MCP Tools2829- **User Management**: 30 - `blazemeter_user` with action `read_user` - Read current user information31 - Returns: User details including default account, workspace, and project3233- **Account Management**: 34 - `blazemeter_account` with action `read` - Read account information35 - `blazemeter_account` with action `list` - List all accounts36 - Required args: `account_id` (integer) for read action3738- **Workspace Management**: 39 - `blazemeter_workspaces` with action `read` - Read workspace details40 - `blazemeter_workspaces` with action `list` - List all workspaces41 - `blazemeter_workspaces` with action `read_locations` - Get location lists42 - Required args: `workspace_id` (integer) for read action, `account_id` (integer) for list action4344- **Project Management**: 45 - `blazemeter_project` with action `read` - Read project information46 - `blazemeter_project` with action `list` - List all projects47 - Required args: `project_id` (integer) for read action, `workspace_id` (integer) for list action4849- **Test Management**: 50 - `blazemeter_tests` with action `read` - Read test details51 - `blazemeter_tests` with action `list` - List all tests52 - `blazemeter_tests` with action `create` - Create new tests53 - `blazemeter_tests` with action `configure_load` - Configure load settings54 - `blazemeter_tests` with action `configure_locations` - Configure location distribution55 - `blazemeter_tests` with action `upload_assets` - Upload test assets56 - Required args: `test_id` (integer) or `project_id` (integer)5758- **Execution Management**: 59 - `blazemeter_execution` with action `start` - Start test execution60 - `blazemeter_execution` with action `read` - Read execution details61 - `blazemeter_execution` with action `list` - List all executions62 - `blazemeter_execution` with action `read_summary` - Get summary report63 - `blazemeter_execution` with action `read_errors` - Get error report64 - `blazemeter_execution` with action `read_request_stats` - Get request statistics65 - `blazemeter_execution` with action `read_all_reports` - Get all reports66 - Required args: `test_id` (integer) or `execution_id` (integer)6768- **Help System**: 69 - `blazemeter_help` with action `list_help_categories` - List help categories70 - `blazemeter_help` with action `list_help_category_content` - List help content71 - `blazemeter_help` with action `read_help_info` - Read help information72 - Required args: Varies by action7374### When to Use MCP Tools vs REST APIs7576- **MCP Tools**: Use for high-level operations, automation workflows, and AI agent interactions77- **REST APIs**: Use for direct API access, custom integrations, and fine-grained control7879### Example Workflow8081**Using MCP Tools for API-like Operations**:821. Use `blazemeter_user` with action `read_user` to get default workspace and project IDs832. Use `blazemeter_tests` with action `list` to find tests (equivalent to GET /tests API)843. Use `blazemeter_execution` with action `start` to execute tests (equivalent to POST /tests/{testId}/start API)854. Use `blazemeter_execution` with action `read_summary` to get results (equivalent to GET /executions/{executionId}/summary API)8687## Reference Files8889### Overview90- **[overview.md](skill-blazemeter-api-reference://references/overview.md)**: BlazeMeter REST APIs, API Overview9192### Authentication93- **[authentication.md](skill-blazemeter-api-reference://references/authentication.md)**: Authorization, API Keys9495### Identifiers96- **[identifiers.md](skill-blazemeter-api-reference://references/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 Name9798### Test Data API99- **[test-data-api.md](skill-blazemeter-api-reference://references/test-data-api.md)**: Test Data API100101### Cloning API102- **[cloning-api.md](skill-blazemeter-api-reference://references/cloning-api.md)**: Cloning API103104### Export API105- **[export-api.md](skill-blazemeter-api-reference://references/export-api.md)**: Export API106107### Bulk Operations108- **[bulk-operations.md](skill-blazemeter-api-reference://references/bulk-operations.md)**: Service Virtualization Bulk Operations APIs109110## When to Use Each Reference111112- **Overview**: When understanding BlazeMeter REST API structure and endpoints113- **Authentication**: When configuring API key authentication or authorization114- **Identifiers**: When obtaining Workspace ID, Project ID, Test ID, or other identifiers for API calls115- **Test Data API**: When using Test Data API for generating and managing test data116- **Cloning API**: When cloning services using the Cloning API117- **Export API**: When exporting services using the Export API118- **Bulk Operations**: When performing bulk operations on Service Virtualization119