Follow

Stop a Multi Test

Description

This API enables you to shut down the Multi Test gracefully (opposed to forcefully terminate it). This function includes parameters to identify both the user and the Multi Test

API v4

URL

https://a.blazemeter.com/api/v4/collections/collectionID/stop

Request Parameters

Parameter Description
Api Key Identifies the user. How to get the API Key?
Collection ID Identifies the Multi test. How to get the Test ID?

cURL

curl -X post https://a.blazemeter.com/api/v4/collections/collectionsID/stop -H "Content-Type: application/json" -H "x-api-key: 62f7f52eb342c3ec1e31"

Python

import requests

def collectionStop(collection_id):
	return requests.post('https://a.blazemeter.com/api/v4/collections/{0}/stop'.format(collection_id), headers={"x-api-key": "65f7f52eb362c4ec2e31"})

res = collectionStop(<collectionID>)
print res.json()

Example Response

{
  "api_version": 4,
  "error": null,
  "result": [
    {
      "test_id": 5349575,
      "sessions": [
        {
          "session_id": "r-v3-587ccbe53f416",
          "result": "shutdown command sent\n"
        },
        {
          "session_id": "r-v3-587ccbe53d02d",
          "result": "shutdown command sent\n"
        },
        {
          "session_id": "r-v3-587ccbe53c8eg",
          "result": "shutdown command sent\n"
        },
        {
          "session_id": "r-v3-587ccbe53ab16",
          "result": "shutdown command sent\n"
        },
        {
          "session_id": "r-v3-587ccbe53ecfj",
          "result": "shutdown command sent\n"
        }
      ]
    }
  ]
}

 

 

API v2

 

URL

https://a.blazemeter.com:443/api/latest/collections/collectionID/stop

Request Parameters

Parameter Description
Api Key Identifies the user. How to get the API Key?
Collection ID Identifies the Multi test. How to get the Test ID?

cURL

curl -X get https://a.blazemeter.com:443/api/latest/collections/collectionsID/stop -H "Content-Type: application/json" -H "x-api-key: 62f7f52eb342c3ec1e31"

Python

import requests

def collectionStop(collection_id):
	return requests.get('https://a.blazemeter.com/api/latest/collections/{0}/stop'.format(collection_id), headers={"x-api-key": "65f7f52eb362c4ec2e31"})

res = collectionStop(<collectionID>)
print res.json()

Example Response

{
    "api_version": 2,
    "error": null,
    "result": [
        {
            "test_id": 50342791,
            "sessions": [
                {
                    "session_id": "r-op-beta556ce0e4af574",
                    "result": "shutdown command sent\n"
                },
                {
                    "session_id": "r-op-beta556ce0f5a2cb8",
                    "result": "shutdown command sent\n"
                },
                {
                    "session_id": "r-op-beta556ce0f87a6cb",
                    "result": "shutdown command sent\n"
                }
            ]
        }
    ]
}
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.