Skip to main content

run_load_test

Dispatch a load run for a load test. Returns the runId immediately; the load pool executes in the background. Depending on the load test's configuration it runs as concurrent browser users replaying your feature journeys (simple mode) or protocol-level k6 traffic (advanced mode).

warning

The load test must be runnable (status generated) and the run is subject to the account's plan load caps and credits — both are enforced server-side and a rejected dispatch comes back as 409 conflict with a human-readable reason.

Request

POST /api/v1/ops/projects/{project}/load/{loadTest}/run
ParameterInTypeRequiredDescription
projectpathstringyesThe project's public id.
loadTestpathstringyesLoad test id or name (see list_load_tests).
siteUrlbodystringnoTarget URL override. Defaults to the load test's configured target, then the project base URL.
curl -X POST -H "Authorization: Bearer $TESTVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"siteUrl": "https://staging.example.com"}' \
"$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/load/31/run"

Response

202 Accepted

{ "runId": 215, "featureId": 31 }

The load run shares the run spine — poll get_run (or use wait_for_run) until status leaves running, and watch live latency / RPS / VU charts in the app's Load section.

Errors

HTTPWhen
404 not_foundNo such load test in this project.
409 conflictNot a load test, no generated load script yet, no target URL, or the plan/credit gate rejected the run.