API Explorer: /multi-tests/{collectionId}/start

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

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 launch. For example, send it using the Master Details API to get the details of this master.

Start a Test Suite

curl 'https://a.blazemeter.com/api/v4/multi-tests/12345678/start' \

    -X POST \
    -H 'Content-Type: application/json' \
    --user 'api_key_id:api_key_secret'

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": "Functional Test Suite",
        "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": 1,
        "parallelTestsInAccount": 1,
        "isSandbox": null,
        "isPrivateData": false,
        "executionMode": "functional",
        "creatorClientId": "gui",
        "executorClientId": "api",
        "importedAt": null,
        "secondsPerLabelDoc": 60,
        "taurusRemoteControlProperties": null,
        "labelsCollectionSuffix": "_17_12",
        "locations": [
            "harbor-5d25f95f206f10730f21f1b4",
            "harbor-59464ffd67f3bf63cb7b23c9"
        ],
        "scenariosMapping": [
            {
                "id": "0d0893db262df70451440cc9fafb1cb29e953ab538fb5d985b15892e1975232e",
                "name": "Scenario 1",
                "test": "Santander Proxy GUI Functional Validation Test",
                "isEndUserExperience": false
            },
            {
                "id": "3b72f4fdbd4000b35e51e4d4db89fe2a02ea2f34f504bfd2c069e6de535f4c62",
                "name": "My Scenario",
                "test": "API Functional Validation Test",
                "isEndUserExperience": false
            }
        ],
        "isDebugRun": false,
        "executions": [
            {
                "concurrency": 1,
                "holdFor": "42720s",
                "durationIsNotConfigured": true,
                "iterations": 1,
                "locations": {
                    "harbor-5d25f95f206f10730f21f1b4": 1
                },
                "locationsWeighted": true,
                "executor": "selenium",
                "testId": 1234567,
                "capabilities": {
                    "browserName": "chrome",
                    "browserVersion": "78",
                    "blazemeter_videoEnabled": true
                },
                "scenario": "Scenario 1"
            },
            {
                "concurrency": 1,
                "holdFor": "42720s",
                "durationIsNotConfigured": true,
                "iterations": 1,
                "locations": {
                    "harbor-59464ffd67f3bf63cb7b23c9": 1
                },
                "locationsWeighted": true,
                "testId": 2345678,
                "scenario": "My Scenario"
            }
        ],
        "concurrency": 1,
        "useV4Pipeline": false,
        "terminatedAt": null,
        "shutdownAt": null,
        "jupyterToken": null,
        "jupyterHeartbeat": null,
        "jupyterHost": null,
        "jupyterPort": null,
        "jupyterNotebook": null,
        "v4IndexerCollection": null,
        "buildId": null,
        "isSelenium": true,
        "isExternal": null,
        "rpsCompatible": null,
        "remoteControlCompatible": null,
        "hasMonitoringData": null,
        "shouldSendReportEmail": true,
        "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": 1592938964,
        "updated": 1592938965,
        "note": null,
        "testCollectionId": 12345678,
        "testId": null,
        "projectId": 123456,
        "scheduleHistoryRecordId": null,
        "jupyterShipId": null,
        "sessionsId": null,
        "functionalSummary": null,
        "gridSummary": null,
        "testSuiteSummary": null
    },
    "request_id": "5ef251d0952ed"
}