Overview
Your Account provides access to different levels of the API:
- Workspaces: Workspaces are the highest level container within an account. They contain projects which in turn contain tests. Workspaces also contain resources such as Dedicated IPs, Private Locations, Application Performance Monitoring (APM) credentials, shared folders, and usage alerts. A user with access to a workspace can access any project in the workspace. Each workspace has its own ID, known as a
workspaceId, which will be required for use in the APIs. - Projects: An organizational construct containing tests and their results. Think of it as a single-dimensional tagging system with each test and the test's results associated with one (and only one) project. Each project has its own ID, known as a
projectId, which will be required for use in the APIs. - Tests: Tests are test objects configured with specific parameters and files. Think of a test as the "recipe" for test which can be run many times. Each test has its own ID, known as a
testId, that will be required for use in the APIs. ThetestIdis for the GUI Functional Tests and API Functional Tests object.
Starting February 2022, the API Functional testing feature has been deprecated. Depending on your subscription plan, you may still be able to run existing tests but can no longer create new ones. Please use BlazeMeter API Monitoring to create and run your API Functional Tests going forward.
- Masters: This is the construct that manages the runs of a test and contains the test run's results. Think of the master as one instance of using the recipe. Each master has its own ID, known as a
masterId, which will be required for use in the APIs.
The following figure illustrates the relationship between the levels.
