Stop
API Explorer: /masters/{masterId}/stop
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). All test files will be archived and uploaded to the Logs report. The sample code stops the master
with a masterId
of 12345678
. Use the actual masterId
in place of 12345678
.
If the stop is unsuccessful, or if an immediate stop takes priority over capturing results, use the Terminate API endpoint.
Attributes
-
session_id
stringThe
sessionId
being stopped -
result
stringWill always contain the string
stopping
when using this API
Stop an Active Test
curl 'https://a.blazemeter.com/api/v4/masters/12345678/stop' \
-X POST \
-H 'Content-Type: application/json' \
--user 'api_key_id:api_key_secret'
Response202 Accepted
{
"api_version": 4,
"error": null,
"result": [
{
"session_id": "r-v4-5abc8b5ad54bb",
"result": "stopping"
}
]
}