Start a Test
API Explorer: /tests/{testId}/start
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
.
NOTE: 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 Stop a Test Run to stop this running instance.
If you do not know the ID of the test to start, use List Tests to return a list of your created tests.
scenarioId
and location id
from this response, which can be used to narrow down your results by the scenario or location. This is covered, in detail, in the Test Results Advanced Settings section.Start a Test
curl 'https://a.blazemeter.com/api/v4/tests/1234567/start?delayedStart=false' \
-X POST \
-H 'Content-Type: application/json' \
--user 'api_key_id:api_key_secret'
Start a Test Parameters
Parameters
-
delayedStart
booleanDenotes if the test run will wait to start for a set amount of time after all engines are ready
Start a Test Request Attributes
Attributes
-
isDebugRun
booleanDenotes if the test will run as a Debug test or not
Start a TestStart a Test POST Body (JSON)
{
"isDebugRun": false
}
Start a Test Response Attributes
For the full details of all the attributes for the test run response, you can visit The Master Object.
Response202 Accepted
{
"api_version": 4,
"error": null,
"result": {
"id": 12345678,
"name": "V4 Remote Control Test",
"userId": 123456,
"publicToken": null,
"ended": null,
"lastUpdate": null,
"delayedStartReady": false,
"runnerUserId": 123456,
"charges": [],
"usage": null,
"maxUsers": null,
"type": null,
"passed": null,
"canControlRampup": null,
"targetThreads": null,
"parallelTestsInWorkspace": 1,
"parallelTestsInAccount": 1,
"isSandbox": null,
"isPrivateData": false,
"executionMode": null,
"creatorClientId": "gui",
"executorClientId": "api",
"importedAt": null,
"secondsPerLabelDoc": 60,
"taurusRemoteControlProperties": null,
"labelsCollectionSuffix": "_17_12",
"locations": [
"us-east-1"
],
"scenariosMapping": [
{
"id": "7955907f886baf352a5dd51d04f91b5c209e9af71fb2f035a785614601f3ffd7",
"name": "default-scenario-1234567",
"test": null,
"isEndUserExperience": false
}
],
"isDebugRun": false,
"executions": [
{
"concurrency": 20,
"holdFor": "19m",
"rampUp": "1m",
"steps": 0,
"throughput": 5,
"locations": {
"us-east-1": 20
},
"locationsPercents": {
"us-east-1": 100
},
"executor": "jmeter",
"scenario": "default-scenario-1234567"
}
],
"concurrency": 20,
"useV4Pipeline": true,
"terminatedAt": null,
"shutdownAt": null,
"jupyterToken": null,
"jupyterHeartbeat": null,
"jupyterHost": null,
"jupyterPort": null,
"jupyterNotebook": null,
"v4IndexerCollection": "{\"execution\":[1],\"execution:1\":[\"r-v4-5c7d64f8c95cf\"],\"session:1\":[\"r-v4-5c7d64f8c95cf\"],\"location:1\":[\"us-east-1\"]}",
"buildId": null,
"isSelenium": false,
"isExternal": null,
"rpsCompatible": true,
"remoteControlCompatible": true,
"hasMonitoringData": null,
"shouldSendReportEmail": false,
"hasDaggerData": false,
"kinesisStream": "prod-grn_v4pipeline_input",
"properties": [
{
"pairs": [
{
"key": "SampleName",
"value": "MySampler1"
}
],
"testId": 1234567,
"locations": [
"us-east-1"
],
"scenarios": [
"7955907f886baf352a5dd51d04f91b5c209e9af71fb2f035a785614601f3ffd7"
]
},
{
"pairs": [
{
"key": "blazemeter.throughput",
"value": 5
}
],
"testId": 1234567,
"locations": [
"us-east-1"
],
"scenarios": [
"7955907f886baf352a5dd51d04f91b5c209e9af71fb2f035a785614601f3ffd7"
]
}
],
"created": 1551721720,
"updated": 1551721720,
"note": null,
"testCollectionId": null,
"testId": 1234567,
"projectId": 123456,
"scheduleHistoryRecordId": null,
"jupyterShipId": null,
"sessionsId": [
"r-v4-5c7d64f8c95cf"
],
"functionalSummary": null,
"thresholds": [
{
"thresholds": [
{
"field": "responseTime.avg",
"label": "ALL",
"op": "gt",
"stopTestOnViolation": false,
"value": "1000",
"isEmpty": false
}
],
"ignoreRampup": false,
"ignoreRampupTime": null,
"slidingWindow": false,
"testId": 1234567
}
]
}
}