Start a Test

To start a preconfigured load test, you need to know the testId of a created and configured test. The sample code executes a test with a testId of 1234567. Use the testId of the actual test to start in place of the 1234567.

You can create and configure the test through the UI or through the API.

The first id returned in the response is a masterId. You can use this ID as a reference to this instance of a test run. For example, send it using Master Details to get the details of this master.

If you do not know the ID of the test to start, use List Tests to return a list of your created tests.

Start a Test

curl 'https://a.blazemeter.com/api/v4/tests/1234567/start' \
    -X POST \
    -H 'Content-Type: application/json' \
    --user 'api_key_id:api_key_secret'

Start a Test Response Attributes

See the The Master Object response attributes for a detailed breakdown of the response attributes.

Response202 Accepted

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 12345678,
        "name": "GUI Functional Test",
        "userId": 123456,
        "publicToken": null,
        "ended": null,
        "lastUpdate": null,
        "delayedStartReady": false,
        "runnerUserId": 123456,
        "charges": [],
        "terminateWorkersExecuted": false,
        "usage": null,
        "maxUsers": null,
        "hasData": null,
        "type": null,
        "passed": null,
        "canControlRampup": null,
        "targetThreads": null,
        "parallelTestsInWorkspace": 2,
        "parallelTestsInAccount": 2,
        "isSandbox": null,
        "isPrivateData": false,
        "executionMode": "functional",
        "creatorClientId": "gui",
        "executorClientId": "api",
        "importedAt": null,
        "secondsPerLabelDoc": 60,
        "taurusRemoteControlProperties": null,
        "labelsCollectionSuffix": "_17_12",
        "locations": [
            "harbor-5d25f95f206f10730f21f1b4"
        ],
        "scenariosMapping": [
            {
                "id": "6a37dfc98ea5e2644a52afc1fe9ad54f44e3577d51b67f2adcef1521aceb58ba",
                "name": "Scenario 1",
                "test": "GUI Functional Validation Test",
                "isEndUserExperience": false
            }
        ],
        "isDebugRun": false,
        "executions": [
            {
                "concurrency": 1,
                "holdFor": "42720s",
                "durationIsNotConfigured": true,
                "locations": {
                    "harbor-5d25f95f206f10730f21f1b4": 1
                },
                "locationsWeighted": true,
                "executor": "selenium",
                "capabilities": {
                    "browserName": "chrome",
                    "browserVersion": "77",
                    "blazemeter_videoEnabled": true
                },
                "scenario": "Scenario 1"
            }
        ],
        "concurrency": 0,
        "useV4Pipeline": false,
        "terminatedAt": null,
        "shutdownAt": null,
        "jupyterToken": null,
        "jupyterHeartbeat": null,
        "jupyterHost": null,
        "jupyterPort": null,
        "jupyterNotebook": null,
        "v4IndexerCollection": "{\"execution\":[1],\"execution:1\":[\"r-v4-5ef24ae129da3\"],\"session:1\":[\"r-v4-5ef24ae129da3\"],\"location:1\":[\"harbor-5d25f95f206f10730f21f1b4\"]}",
        "buildId": null,
        "isSelenium": true,
        "isExternal": null,
        "rpsCompatible": false,
        "remoteControlCompatible": false,
        "hasMonitoringData": null,
        "shouldSendReportEmail": false,
        "shouldUseDaggerReport": null,
        "hasDaggerData": false,
        "kinesisStream": "prod-purp_v4pipeline_input",
        "useJetlag": false,
        "properties": null,
        "jetpackLabels": null,
        "dependencies": null,
        "env": "https://a.blazemeter.com",
        "reportUrl": null,
        "enableFailureCriteria": [],
        "created": 1592937184,
        "updated": 1592937185,
        "note": null,
        "testCollectionId": null,
        "testId": 1234567,
        "projectId": 123456,
        "scheduleHistoryRecordId": null,
        "jupyterShipId": null,
        "sessionsId": [
            "r-v4-5ef24ae129da3"
        ],
        "functionalSummary": null,
        "gridSummary": null,
        "testSuiteSummary": null
    },
    "request_id": "5ef24ae0a04b4"
}