Stopping the Recording Process

Necessary data

To proceed with the steps described below, the following pieces of data are required:

  • a token
  • a test run identifier

    You can get detailed information about test run and token here.

    The following values are used as example values in this document:

  • token_Qwe12345 as a token.
  • tr_1234 as an identifier of a test run.

Stop the recording process by issuing the following API call:

POST

Stop Recording Process

https://us1.api.wallarm.com/v1/test_run/test_run_id/action/stop
API call: POST /v1/test_run/test_run_id/action/stop
Authorization: Required With the token
HTTP header with the token: X-WallarmAPI-Token Serves to pass the token’s value to the API server
Parameters: test_run_id (required) The identifier of the test run to stop recording the baseline requests for



Example of a request:

curl --request GET \
  --url https://us1.api.wallarm.com/v1/test_run/tr_1234/action/stop \
  --header 'Host: us1.api.wallarm.com' \
  --header 'X-WallarmAPI-Token: token_Qwe12345'

Example of a response:

{
  "status": 200,
  "body": {
    "id": tr_1234,
    ...
    "recording": false,
    ...
  }
}

If the request to the API server is successful, you are presented with the server’s response. The response provides useful information, including:

  • the state of the recording process (the recording parameter’s value).
  • the identifier of the corresponding test record (the test_record_id parameter).

If the parameter’s value is false, then the stop is successful.

If the stop is successful, it is possible to use the test record with the test_record_id identifier to copy test runs.

results matching ""

    No results matching ""