# BlazeMeter integration

> BlazeMeter load and performance testing API: tests, multi-tests, test runs and results, schedules, workspaces, private locations, virtual services (service virtualization) and test data.

- Authentication: apiKey

## Tools (167)

- **Account engine utilization report**: To the engine utilization report for your account, you need the accountId of the account to get the engine utilizataion report and use an API key that has account admin access.
- **Account functionalities list**: To return a list of the account functionalities supported, an accountId is required.
- **Add a public token**: To create a public token for a given master, you need to know the masterId of a givne master.
- **Add a workspace to private location**: To create a workspace to your private location, you will need to know the harborId and the workspaceId.
- **Add tests to multi-test**: To add tests to a multi-test, you need to provide a list of testIds to be added.
- **Add user to account**: To add a user, you need the accountId of the account you want to add the user to and use an API key that has account admin access.
- **Add user to workspace**: To add a user to a workspace, you need the workspaceId of the workspace you want to add the user to and use an API key that has account admin access or a workspace manager role.
- **Agent details**: To return the details of an agent, a harborId and a shipId is required.
- **Apply template to virtual service**: To apply an existing template to a virtual service, you need to know your workspace identifier and the virtual service template identifier.
- **Authenticate credentials with user name and password**: Authenticate integrated apps using user name and account password ("Access Key").
- **Check file validation**: To get the status of the test file validations, use GET to pull the validation list for a given test (you need to know the testId).
- **Configure and deploy virtual services**: To configure or deploy virtual services, you need to know your workspace identifier.
- **Configure or reconfigure virtual services**: To configure or reconfigure an existing virtual service, you need to know your workspace identifier and the virtual service identifier.
- **Create a Data Model**: Store a Data Model (or a Data Model file) in the Asset Repository.
- **Create a multi-test**: See Update a Multi-Test for more information.
- **Create an agent**: To create an agent, POST the provided configuration (you will need to know the harborId).
- **Create a package**: Create an Asset Repository package to organize Data Models and other assets.
- **Create a private location**: Once created, a private location can be used as a location to run your tests in, so make sure to save the id for later use.
- **Create a project**: Create a project.
- **Create a schedule**: You can find the information for creating a schedule for a test and multi test.
- **Create a service**: To create a Service in your workspace, you need to know your workspace identifier.
- **Create a shared folder**: Once created, a shared folder can be used as part of any of your tests, so make sure to save the id attribute value for later use.
- **Create a tag (Performance)**: You can use tags when you search and filter Performance tests.
- **Create a tag (Virtual Services)**: You can use tags when you search and filter transactions or services.
- **Create a test**: Once created, a test can be executed as part of any of your workflows, so make sure to save the id attribute value for later use.
- **Create a workspace**: Create a workspace.
- **Create credentials**: Create new credentials which will be used by APM integrations.
- **Create transaction from sources**: To create a transaction from a source file, you need to know your workspace identifier and the service identifier.
- **Create transactions**: To create a transaction, you need to know your workspace identifier and the Service identifier.
- **Create virtual services**: To create a virtual service in your workspace, you need to know your workspace identifier.
- **Create virtual service template**: To create a virtual service templates, you need to know your workspace identifier and the service identifier.
- **Customize Welcome screen**: The account Welcome screen is visible to any user that accepts an invitation to an account without being added to a workspace.
- **Delete a Data Model**: Delete a Data Model asset from a workspace.
- **Delete a multi-test**: To delete a multi-test, delete its ID (you need to know the collectionId).
- **Delete an agent**: To delete an agent, DELETE the provided configuration (you will need the harborId and shipId).
- **Delete a private location**: To delete a private location, DELETE the provided configuration (you will need the harborId).
- **Delete a project**: To delete a project, DELETE its ID (you need to know the projectId).
- **Delete a public token**: To delete a public token from a master, you need to know the masterId that is using the public token.
- **Delete a schedule**: To delete a test schedule, you need to know the scheduleId.
- **Delete a shared folder**: To delete a shared folder, you need to know the folderId.
- **Delete asset file**: To delete an uploaded file from a created test, you need to know the testId and the filename.
- **Delete a test**: To delete a test, DELETE its ID (you need to know the testId).
- **Delete a test in multi-test**: To remove a test from a multi-test, you need to provide the index value of the test you want to remove.
- **Delete a workspace in private location**: To delete a workspace from a private location, DELETE the provided configuration (you will need the harborId and workspaceId).
- **Delete data files**: To delete a data file from a multi-test, you need to send the fileName of the file you want to remove from the multi-test.
- **Delete log analysis**: Deletes an analysis job and its results.
- **Delete logs**: To remove logs for a given master, replace the workspaceId.
- **Delete shared folder file**: To delete an uploaded file from a shared folder, you need to know the folderId and the filename.
- **Delete tag (Performance)**: To delete a tag, you need to know the tag identifier.
- **Delete tag (Virtual Services)**: To delete a tag, you need to know the tag identifier.
- **Delete transaction**: To delete a transaction, you need to know the transaction identifier and your workspace identifier.
- **Delete virtual services**: To delete a virtual service, you need to know your workspace identifier and the virtual service identifier.
- **Delete virtual service template**: To delete a virtual service template, you need to know your workspace identifier and the virtual service template identifier.
- **Deploy virtual services**: Use this request to deploy a container based on the virtual service if it has not already been deployed.
- **Diff users with permissions**: List account users whose SSO group permissions differ from their legacy manual roles.
- **Duplicate a multi-test**: To duplicate a test suite, a collectionId is required.
- **Duplicate a test**: To duplicate a test suite, a testId is required.
- **Edit tests in multi-test**: To edit a test in a multi-test, you need to provide the index of the test you want to change and setting the overrideExecutions values to the desired values.
- **Error statistics**: Aggregated statistics are kept for HTTP errors, failed assertions, and failed embedded resources (embedded resources that returned non-200).
- **Generate Docker command**: To generate a Docker command, you will need to know the harborId and shipId.
- **Generate test data from a model (single entity)**: Generate data for one entity of a Data Model passed in the request body.
- **Generate test data from a stored Data Model**: Generate data for a Data Model stored in the Asset Repository.
- **Get a Data Model**: Get one Data Model by its identifier.
- **Get all conflicting transactions**: To get all conflicting transactions from a service, you need to know your workspace identifier.
- **Get all services**: To get all services of a workspace, you need to know your workspace identifier.
- **Get all tags (Performance)**: This call returns a list of all tags defined in workspace.
- **Get all tags (Virtual Services)**: You can use tags when you search and filter transactions or Services.
- **Get all transactions**: To get all transactions within a Service, you need to know your workspace identifier and the service identifier.
- **Get all virtual services**: To get all virtual services, you need to know your workspace identifier and the Service identifier.
- **Get all virtual service templates**: To get all virtual service templates, you need to know your workspace identifier and the service identifier.
- **Get list of card issuers**: List credit card issuers available for generating card numbers.
- **Get list of Data Generator functions**: List the functions usable in Data Model requirements.
- **Get list of seed lists**: List the seed lists (sample text files such as countries, names, banks) usable for test data.
- **Get service by ID**: To get a service of your workspace, you need to know your workspace identifier and the Service identifier.
- **Get tag by ID**: To get a tag, you need to know either the tag identifier or its name.
- **Get tag by name**: To get a tag, you need to know either the tag name or its identifier.
- **Get time-series KPIs**: List the KPIs and labels available as time-series data for a test run.
- **Get time-series KPI values**: Retrieve time-series values for one KPI of a test run, at 1, 10 or 60 second granularity.
- **Get transaction**: To get a transaction, you need to know your workspace identifier and the transaction identifier.
- **Get virtual service**: To get a virtual service, you need to know your workspace identifier and the virtual service identifier.
- **Get virtual service analytics**: To retrieve log information for any virtual service through our analytics endpoint, you need the Request ID of the virtual service.
- **Get virtual service locations of a workspace**: To get the location of your workspace, you need to know your workspace identifier.
- **Get virtual service request analytics**: You can retrieve inspection data for any virtual service through our analytics endpoint.
- **Get virtual service template**: To get a virtual service template, you need to know your workspace identifier and the virtual service template identifier.
- **Global search**: Use this endpoint to search for entities such as accounts, workspaces, projects, users, tests, tags, and locations.
- **GUI Functional full report**: GUI Functional full report.
- **GUI Functional scenarios summary**: To get GUI functional scenarios summary statistics, you will need a masterId and the corresponding testId for that master.
- **GUI Functional summary statistics**: GUI Functional summary statistics.
- **Import transactions**: Use this API to upload files of transactions to lists of generic DSLs that can be used in BlazeMeter.
- **Inject custom time series data**: A sequence of two POST requests with the same ts value within the id_ will append the KPIs of the second POST request to the KPI values written by the previous POST request.
- **List account invitations**: List account invitations.
- **List account users**: To return a list of the account users, an accountId is required.
- **List agents**: To return a list of created agents, a harborId is required.
- **List all Data Models**: List the Data Models stored in a workspace.
- **List data files**: To return a list of files in a test, a collectionId is required.
- **List masters**: The response shown includes one masterId ("id": 12345678).
- **List multi-tests**: To return a list of created multi-tests, a projectId or a workspaceId is required.
- **List private locations**: To return a list of created private locations, an accountId or a workspaceId is required.
- **List private locations supported browsers**: The returned list contains each private location's location Id (shows up as id in the response), name, and supported browser versions.
- **List projects**: To return a list of the projects, a workspaceId or an accountId is required.
- **List schedule history**: To return a list of test schedules, an accountId, a projectId, a workspaceId, a collectionId, a testId, OR a scheduleId is required.
- **List schedules**: To return a list of test schedules, an accountId, a projectId, a workspaceId, a collectionId, OR a testId are required.
- **List shared folder files**: To get the list of shared folder files, you will need the folderId.
- **List shared folders**: To get the list of shared folders, you will need the workspaceId for where the shared folder is held.
- **List test files**: To return a list of files in a test, a testId is required.
- **List tests**: To return a list of created tests, either a projectId or a workspaceId, and a type attribute is required.
- **List users with permissions**: This endpoint returns a list of all users in a given account, along with their current effective permissions.
- **List workspaces**: To return a list of the workspaces, an accountId is required.
- **List workspace users**: To return a list of the workspace users, a workspaceId is required.
- **Master details**: The pass/failure status of the master is represented as a boolean value ("true" for pass, "false" for fail) that follows the attribute "passed".
- **Multi-test details**: To return the details of a specific multi-test, a collectionId is required.
- **Perform bulk operation over transactions**: To perform a bulk delete or tag operation over several transactions in a workspace, you need to know your workspace identifier.
- **Private location details**: To return the details of a private location, a harborId is required.
- **Private location image versions**: To return a list of the latest image versions, a harborId and a shipId is required.
- **Project details**: To return the details of a project, a projectId is required.
- **Publish Data Model**: Run API Publish (orchestration) stand-alone: send data rows to your test environment through configured HTTP requests.
- **Refresh the logs of a virtual service**: Before you can get a log of a virtual service in the asset catalog, you must refresh the log.
- **Remove managers from workspace**: To remove managers from a workspace, replace the workspaceId 123456 with the workspaceId of your workspace, and provide the Manager IDs of the managers to remove.
- **Request statistics**: The reportId mentioned in the API explorer is aggregatereport for this case.
- **Restore reports of an archived master**: To restore an archived report, use POST.
- **Retrieve logs**: Note: The reportId mentioned in the API explorer is always logs for this case.
- **Schedule details**: To return the details of a test schedule, a scheduleId is required.
- **Shared folder details**: To get the details of a shared folder, you will need the folderId.
- **Start a multi-test**: To start a preconfigured load test, you need to know the collectionId of a created and configured test.
- **Start a test**: To start a preconfigured load test, you need to know the testId of a created and configured test.
- **Stop all masters of a test**: To stop all active masters of a test, POST the testId to the /tests/{testId}/stop API.
- **Stop a test run**: To stop the active master (or test report) of a given test run gracefully (by signaling to JMeter to close the session), POST the masterId to the stop command (you need to know the masterId of the active session to stop).
- **Stop a virtual service**: To stop a virtual service, you need to know your workspace identifier and the virtual service identifier.
- **Submit log analysis request**: Submits a new log analysis job for processing.
- **Summary statistics**: The reportId mentioned in the API explorer is always default for this case.
- **Take a log snapshot of a virtual service**: To request a log snapshot of a virtual service, you need to know your workspace identifier and the virtual service identifier.
- **Terminate a test run**: To terminate a master (or test report), POST the masterId to the terminate command (you need to know the masterId of the running test).
- **Terminate masters in account**: To terminate all running masters in an account, you need the accountId of the account and account admin access.
- **Terminate masters in projects**: To terminate all running masters in a project, you need the projectId of the project.
- **Terminate masters in workspace**: To terminate all running masters in a workspace, you need the workspaceId of the workspace.
- **Test details**: To return the details of a specific test, a testId is required.
- **Test suite summary (GUI Functional)**: To get the summary details from a test suite master, a masterId is required.
- **Thresholds statistics**: You will find all the details of which criteria you set passed or failed and where (if any) those violations occurred.
- **Track log analysis progress**: Tracks status of the log analysis.
- **Track status of a test run**: To obtain the present status of a test run, use its masterId and the status endpoint.
- **Update account user**: To change a user's account role or disable or enable a user, an accountId and userId are required.
- **Update a master**: To update a test, use PATCH to change the provided configuration for a given test (you need to know the masterId).
- **Update a multi-test**: To update a multi-test, use PUT to change the provided configuration for a given test (you need to know the collectionId).
- **Update an agent**: To update an agent, you will need to know the harborId and the shipId.
- **Update a private location**: To update a private location, you will need to know the harborId.
- **Update a project**: To update a project, use PATCH to change the provided configuration for a given project (you need to know the projectId).
- **Update a service**: To update the name and description of an existing Service in your workspace, you need to know your workspace identifier and the Service identifier.
- **Update a shared folder**: To update a shared folder, you need to know the folderId.
- **Update a tag**: To update the name or description of an existing tag, you need to know the tag identifier.
- **Update a test**: To update a test, use PATCH to replace the provided parameter values for a test specified by its testId.
- **Update a virtual service**: To update an existing virtual service in your workspace, you need to know your workspace identifier and the virtual service identifier.
- **Update schedule**: To update a schedule, use PATCH to change the provided configuration for a given schedule (you need to know the scheduleId).
- **Update test tags**: Set the tags assigned to a test by sending the full list of tag ids.
- **Update the log snapshot of a virtual service**: To update a log snapshot of a virtual service and save it to the asset catalog, you need to know the log identifier, workspace identifier and the virtual service identifier.
- **Update transaction**: To update an existing transaction in your workspace, you need to know your workspace identifier and the transaction identifier.
- **Update virtual service properties**: To update properties of an existing virtual service in your workspace, you need to know your workspace identifier and the virtual service identifier.
- **Update virtual service template**: To update a virtual service template, you need to know your workspace identifier and the virtual service template identifier.
- **Update virtual service template properties**: To update the properties of a virtual service template, you need to know your workspace identifier and the virtual service template identifier.
- **Update workspace user**: To change a user's workspace role and disable or enable an user in the workspace, a workspaceId and an userId are required.
- **Upload or update multi-test data files**: To upload or update an asset file, first get a signed URL, and then use it to upload the file.
- **Upload or update shared folder files**: To upload or update an asset file, first get a signed URL, and then use it to upload the file.
- **Upload or update test asset files**: To upload a file asset to a test, POST the file to the testId (you need to know the testId of the created test).
- **Validate a Data Model (JSON document)**: Validate a Data Model JSON document sent in the body.
- **Validate a file**: To validate a JMeter or Taurus YAML file, use POST to run a validation for the given file (you need to know the testId).
- **Validate a stored Data Model**: Validate a Data Model stored in the Asset Repository, optionally with a model override.
- **Validate virtual service Taurus dependencies**: To validate Taurus configuration dependencies, you need to know your workspace identifier.
- **Workspace details**: To return the details of a workspace, a workspaceId is required.

Connect BlazeMeter in General Input: https://www.generalinput.com/apps/blazemeter