Terminate

API Explorer: /masters/{masterId}/terminate

To terminate a master (or test report), POST the masterId to the terminate command (you need to know the masterId of the running test). There will be no archiving or uploading of test files to the Log report (all test files will be lost). The sample code stops the master with a masterId of 12345678. Use the actual masterId in place of the 12345678.

To avoid losing test results, use the Stop API endpoint, instead of terminate. Use terminate only when the Stop API endpoint is unsuccessful or stopping the test immediately takes priority over capturing results.

Attributes

  • session_ids array

    The list of sessionIds being terminated

  • result string

    Will always contain the string Terminating when using this API

Terminate Servers Running a Master 

curl 'https://a.blazemeter.com/api/v4/masters/12345678/terminate' \
    -X POST \
    -H 'Content-Type: application/json' \
    --user 'api_key_id:api_key_secret'

Response202 Accepted 

{
    "api_version": 4,
    "error": null,
    "result": [
        {
            "sessions_ids": [
                "r-v4-5c7d84e668624"
            ],
            "result": "Terminating"
        }
    ]
}