Stopping the Recording Process

Necessary data

To stop recording via API, the following pieces of data are required:

  • a token
  • a test run identifier

To stop recording via web interface, you need a Wallarrm account.

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.

The need to stop baseline requests recording is described by the link.

Stopping the Recording Process via API

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.

Stopping the Recording Process via Web Interface

To stop the recording process via the web interface, please follow the steps below:

  1. Go to your Wallarm account > Test runs by this link for the EU cloud or by this link for the US cloud.

  2. Select the test run to stop recording for and open the action menu.

  3. Select Stop recording.

    Stopping the recording via web interface

The REQ indicator to the left of the Baseline req. column will be switched off when the recording is stopped.

ID of the test record is displayed in the Test record name/Test record ID column.

If required, you can copy this test run using the web interface and the new test will reuse the mentioned test record.

results matching ""

    No results matching ""