Launch on several environments: one run each, one group
const url = 'https://beta-api.plune.ai/v1/run-groups';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"title":"Checkout · release 2.4","kind":"automated","environments":["staging","production","dev"],"strategy":"realistic"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://beta-api.plune.ai/v1/run-groups \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "title": "Checkout · release 2.4", "kind": "automated", "environments": [ "staging", "production", "dev" ], "strategy": "realistic" }'A launch on 2 to 10 environments (#1252, ADR 0071 §3) makes one run per environment and a group that holds them, in one transaction: all the runs or none. Each run gets its environment, a run key of its own (externalKey, rk_…) for the reporter of that environment to join by, and the group; the rest of the body is the same for all. The daily run quota is asked for all of them at once: a day with fewer places left than environments answers 429 and writes nothing. The group’s create is an entry of the feed (run_group) with the title, the strategy, the environments and the runs. Anyone but a reader launches, as a run. One environment is POST /v1/runs.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”A launch on several environments (#1252, ADR 0071 §3): the fields of a RunStart but schemaVersion, environment and externalKey, and the environments and the strategy. Every run of the group takes the same kind, title, configuration, custom (and so the same combinations), labels, meta, assignment and schedule - each its own environment, and a run key (rk_…) the server issues, for the reporter of that environment to join by (PLUNE_RUN=<key>).
object
One run each, 2 to 10. None named twice by the rule of the environment list (lower-cased and trimmed of spaces, tabs, carriage returns and line feeds: «staging» and «Staging » are one). A value outside the list is taken, as on a single run. One environment is POST /v1/runs.
When the group passes. realistic — the group passed when every environment passed; optimistic — when at least one passed; pessimistic — it failed only when every environment failed. While any environment is running the group is running, whatever the strategy. optimistic and pessimistic differ only when no environment passed and some are broken or skipped: then pessimistic passes and optimistic fails. Kept on the group; PATCH /v1/run-groups/{id} changes it.
The group’s name, and the title of each of its runs.
What the run expects to happen. Without it, a crashed shard is indistinguishable from a green run.
object
object
object
Deprecated: not read; configurations are run fields (ADR 0070). Taken and stored as sent.
object
The caller states that expected is everything its source has — the whole suite, not one file or a --grep. When such a run finishes with an empty notRun, every active case that this source (the source of the run’s results) reported before and did not report in this run moves to detached, with the run named as the reason. Manual cases, other sources, in_review and deprecated cases are never touched; a later result on a detached case brings it back to active by itself. Set it only for the run that covers the whole suite (PLUNE_FULL_RUN=1 in the CLI).
Who is to run which case (B8-team T4): testCaseId → userId. Filled at launch by assignment: prefer-assignee from each expected case’s assigneeId at that moment — a snapshot, so a case that changes hands later does not rewrite a run under way. Cases nobody holds are absent. May also be sent as is.
object
object
The commit the run was made from — run.sha in GET /v1/runs/{id}/summary.
The branch it was made on — run.branch in GET /v1/runs/{id}/summary.
The CI run that produced the report — the reporter reads the runner’s own config.metadata.ci.buildHref. Sanitized before it is stored (a credential in a query parameter becomes a marker); set by the shard that opens the run and never changed by one that joins it. The run page links it from GET /v1/runs/{id}/summary.
The tool that reported the run — playwright, or the report format plune run import read — not the machine of the CI; run.runner in GET /v1/runs/{id}/summary.
The plan the run was launched from (D33), when it was — what GET /v1/runs?planId= filters by.
How many cases the plan’s collections selected when the run was launched (#1274); a count taken then, so it does not follow the plan afterwards.
The plan’s collections (filter query strings) as they stood when the run was launched (#1274); a copy, so the run still says what it selected by after the plan is edited or deleted.
As on RunStart, once for all the runs.
Save rather than Launch: every run is created scheduled (as on RunStart).
As on RunStart, checked once and set on every run.
object
Example
{ "title": "Checkout · release 2.4", "kind": "automated", "environments": [ "staging", "production", "dev" ], "strategy": "realistic"}Responses
Section titled “ Responses ”The group and its runs, in the order of environments
object
A launch on several environments (#1252): one run each, and the strategy that makes their statuses one verdict. Its status is computed when read, never stored.
object
Who launched it.
object
The value rerun is reached only by joining a terminated run again — it is never requested. scheduled (#1233): saved and not launched yet — launch, or a reporter joining by its key, starts it.
What the run expects to happen. Without it, a crashed shard is indistinguishable from a green run.
object
object
object
Deprecated: not read; configurations are run fields (ADR 0070). Taken and stored as sent.
object
The caller states that expected is everything its source has — the whole suite, not one file or a --grep. When such a run finishes with an empty notRun, every active case that this source (the source of the run’s results) reported before and did not report in this run moves to detached, with the run named as the reason. Manual cases, other sources, in_review and deprecated cases are never touched; a later result on a detached case brings it back to active by itself. Set it only for the run that covers the whole suite (PLUNE_FULL_RUN=1 in the CLI).
Who is to run which case (B8-team T4): testCaseId → userId. Filled at launch by assignment: prefer-assignee from each expected case’s assigneeId at that moment — a snapshot, so a case that changes hands later does not rewrite a run under way. Cases nobody holds are absent. May also be sent as is.
object
object
The commit the run was made from — run.sha in GET /v1/runs/{id}/summary.
The branch it was made on — run.branch in GET /v1/runs/{id}/summary.
The CI run that produced the report — the reporter reads the runner’s own config.metadata.ci.buildHref. Sanitized before it is stored (a credential in a query parameter becomes a marker); set by the shard that opens the run and never changed by one that joins it. The run page links it from GET /v1/runs/{id}/summary.
The tool that reported the run — playwright, or the report format plune run import read — not the machine of the CI; run.runner in GET /v1/runs/{id}/summary.
The plan the run was launched from (D33), when it was — what GET /v1/runs?planId= filters by.
How many cases the plan’s collections selected when the run was launched (#1274); a count taken then, so it does not follow the plan afterwards.
The plan’s collections (filter query strings) as they stood when the run was launched (#1274); a copy, so the run still says what it selected by after the plan is edited or deleted.
What to call this run in a list. The first shard to declare one wins; a shard that arrives later fills a field left empty rather than overwriting.
Where it ran — staging, prod, a preview. Filterable on GET /v1/runs, so two CI matrices read as two histories.
How the run is marked — smoke, nightly, a team name. An empty array is how every mark is removed.
What the run is for, in a person’s words (#1232) — plain text; null when nobody wrote one.
Values of the project’s custom fields (#1764), field id → value. Absent while the run has none. Not configuration, which is the execution plan and is no field.
object
The combinations of configuration values the run was launched with (#1251), in the order of the groups and of their values: Chrome · Windows, Chrome · macOS, Firefox · Windows, Firefox · macOS. Computed by the server from custom when the run is created and frozen; the values of a group cannot change afterwards. Absent for a run launched with none. The one addition: a batch from CI that names a combination the list lacks (configuration of POST /v1/runs/{id}/results) appends it at the end — a number, once given, never changes.
One combination of configuration values (#1251, ADR 0070 §2): a value of each chosen group, the groups in their order. Names are frozen at launch: a rename later changes no past run.
object
object
The group (a field with role: configuration); null with optionId for a value CI named that is not in the list.
The value (an option of the group); null for a value CI named that is not in Settings → Configurations — «not in the list», kept as it was sent.
The name of the group at launch.
The label of the value at launch.
What a run amounted to, frozen at finish. Distinct from RunSummary, which is the list-item shape.
object
One entry per status that occurred, and muted when a muted case failed or broke; an absent key means zero. A failed or broken result of a muted case is counted as muted, not as a failure; a finished run never changes (#1247).
object
counts again, by the priority each result’s case had when the run finished (#1379): { "critical": { "passed": 4, "failed": 1 } }. It is what Analytics counts a finished run under by priority, so a case’s priority changed later moves none of it. Absent from a summary frozen before it was kept.
object
object
Expected and never reported — what keeps a dead shard from looking green.
Cases a retest reset that wait for a new result (#1767): in no count, not in notRun, not in total. Only on a live summary: a run cannot finish while any wait, so a frozen one never has it.
Only for a run with configurations (#1251, ADR 0070 §4): the counts again per combination, in the order of the run’s combinations. notRun and awaitingRetest are by the pair (case, combination): a combination nobody reported has empty counts, total 0 and every expected case in notRun — none of it is counted as skipped. The run’s own notRun is then the cases with a result in no combination, its awaitingRetest the cases waiting in any one.
object
One entry per status that occurred in this combination; an absent key means zero.
object
Expected cases with no current result in this combination.
Cases a retest reset that wait for a new result in this combination; absent for none.
Only for a run with configurations (#1251): the cases that have a result, by where each stands — the worst of its combinations (failed, broken, blocked, muted, passed, skipped): «4 of 120 cases failed». A case in the Bin is not counted (as in /cases?status= and the re-run).
object
Who launched it (B8-team T3): the userId of the session, or of the owner of the token that started or synced it — the first shard to create the run; a joiner is not recorded. null for a run from before names were kept. Resolve it to a name through GET /v1/members.
Example
{ "group": { "id": "7a2d4c1e-0000-4000-8000-00000000a252", "title": "Checkout · release 2.4", "strategy": "realistic", "createdBy": "u-shop", "createdAt": "2026-09-16T09:12:04.151Z" }, "runs": [ { "id": "6f1c2b3a-0000-4000-8000-0000000000d1", "projectId": "u-shop::default", "kind": "automated", "externalKey": "rk_4f7c2a9e1b", "statusEvent": "launched", "configuration": { "full": true, "expected": [ { "testCaseId": "6f1c2b3a-0000-4000-8000-0000000000c1" }, { "externalKey": { "kind": "path-title", "value": "e2e/checkout.spec.ts > Checkout — coupon applied" } } ] }, "meta": { "sha": "3e31591", "branch": "master", "ciUrl": "https://github.com/plune-ai/plune/actions/runs/35003177826", "runner": "playwright" }, "startedAt": "2026-09-16T09:12:04.151Z", "finishedAt": null, "terminateReason": null, "summary": null, "title": "Checkout · release 2.4", "environment": "staging", "labels": [ "plune", "vitest", "ci" ], "description": null, "createdBy": "u-shop" } ]}Invalid body: fewer than 2 environments or more than 10, one named twice, an unknown strategy, or a custom the project’s run fields refuse
object
Example generated
{ "error": "example"}No / invalid token or session
A reader launches nothing
object
Example generated
{ "error": "example"}Two refusals share this status, and what to do about them is opposite. Rate-limited — the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442, #2092): Retry-After carries the seconds until the window rolls over, and waiting that long is the way out. Quota reached — a ceiling on what the project holds (runs in the last 24 hours, test cases, items waiting in the review queue): { error, quota }. A retry straight away frees nothing, so do not loop on it; the message says what makes room — deleting cases, working the queue down, an operator raising the limit — and the run quota, a rolling 24 hours, frees its oldest runs as they age out. Tell the two apart by the body: a 429 whose body has a quota object is a quota, one without it is a throttle. quota carries kind, limit, used, remaining and resetsAt: the figures behind the sentence, and for the run quota the instant its oldest run ages out (#1258). Retry-After is sent on a quota only where there is such an instant (the run quota: the whole seconds, at least 1, until resetsAt); the case, review-queue and project quotas free only by an action, have resetsAt: null, and send no Retry-After. GET /v1/quotas reads the same figures without a refusal.
object
The body of a 429 that is a quota and not a throttle: the sentence, and the figures behind it.
object
What was reached and the way out.
object
The ceiling. A write that would take used past it is refused with 429.
What the project holds now, counted by the same query that refuses a write.
limit - used, never below 0.
When the oldest counted run ages out of the rolling 24 hours and a slot frees on its own. null for the two quotas only an action frees (delete cases, decide queue items), and for a run quota with no runs in the window.
Example
{ "quota": { "kind": "runsPerDay" }}Headers
Section titled “Headers ”Seconds until the window rolls over on a throttle; on a quota, until quota.resetsAt — sent only for the run quota, which has one