Start a load test
start_load_testLoad tests the user's app on a real cloud server and returns a run id. The target is a public or connected GitHub repository URL, or a Docker image. Lite is free once per GitHub account (500 users, 4 minutes). Standard (2,500 users, 10 minutes) costs 1 credit and Massive (10,000 users, 15 minutes) costs 3. A paid run is only started with confirm_spend set to true, and only after the user has agreed to the price. Without a tier it uses the free Lite run when the account still has it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| env | No | Environment variables the app needs to boot, such as NODE_ENV or a test database URL. Stored encrypted and wiped after the run. Never send production secrets. | |
| port | No | The port the app listens on inside its container. Read it from the code. Stresix tries 80, 3000, 5000, 8000 and 8080 when it is left out. | |
| tier | No | Run size. Leave it out to use the free Lite run when available. | |
| paths | No | GET paths the simulated users rotate through, for example ["/", "/api/products", "/search?q=shoes"]. Pick pages that hit the database. Defaults to ["/"]. | |
| branch | No | Repository branch to build. The default branch when left out. | |
| target | Yes | GitHub repository URL (https://github.com/owner/repo) or a Docker image (nginx:1.27, ghcr.io/owner/app:tag). | |
| confirm_spend | No | Set to true only after the user agreed to spend credits on this run. |