For the complete documentation index, see llms.txt. This page is also available as Markdown.

update_load_test

Edit a load test's name and/or configuration.

Edit an existing load test. A non-empty name renames it; any configuration field replaces the stored configuration and re-finalizes runnability — a simple test becomes generated once it has a journey (else draft), an advanced test rebuilds its k6 script. Send only a name (no config) to rename without touching the configuration.

The configuration fields are identical to create_load_test.

Request

PATCH /api/v1/ops/projects/{project}/load/{loadTest}
Parameter
In
Type
Required
Description

project

path

string

yes

The project's public id.

loadTest

path

string

yes

Load test id or name (see list_load_tests).

name

body

string

no

New display name.

config

body

object

no

Replacement LoadConfig document (see create_load_test). Absent leaves the stored config untouched.

Provide a name, a config, or both — an empty edit is a 400.

# Rename only
curl -X PATCH -H "Authorization: Bearer $TESTVIBE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Checkout — Black Friday"}' \
  "$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/load/51"

# Bump the load
curl -X PATCH -H "Authorization: Bearer $TESTVIBE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"config": {"mode": "advanced", "paths": ["/"], "vus": 100, "durationSeconds": 600}}' \
  "$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/load/51"
testvibe load update 51 --name "Checkout — Black Friday"
testvibe load update "Checkout under load" --vus 100 --duration 600

Tool update_load_test{ "loadTest": "Checkout under load", "vus": 100, "durationSeconds": 600 }.

Response

200 OK

Errors

HTTP
When

400 invalid_request

Neither name nor config supplied.

404 not_found

No such load test in this project.

409 conflict

The target feature is not a load test.

Last updated

Was this helpful?