Delete unfinished plans
Deletes the queued and running plans that match in the request's tenant and model set, newest first, each as DELETE /plans/{id}?unless=saved does: a running plan stops after its chunks in flight, and a saved or shared plan stays, counted in kept.
Delete unfinished plans
/plansDeletes the queued and running plans that match in the request's tenant and model set, newest first, each as DELETE /plans/{id}?unless=saved does: a running plan stops after its chunks in flight, and a saved or shared plan stays, counted in kept.
Filters
status=running is required (a queued plan reads running), with at least one of created_by, created_from and created_to; each one sent narrows the match. A done or failed plan is never touched. Any other parameter is a 400, so a misspelt filter can't widen the delete.
Limits
One call deletes at most 200 plans; remaining counts the matches left, so call again until it is 0.
Parameters
Query parameters
statusstringRequiredrunning: the queued and running plans. Missing or any other value is a 400."running"created_bystringOptionalme: only the plans the request's user posted, matched on the stored email; older plans name no one and don't match. Reach another user's plans bycreated_fromandcreated_to. Any other value is a 400: an email never goes in a URL."me"created_fromstringOptionalFormat
date-timeOnly plans created at or after this date-time, such as
2026-11-12T00:00:00Z. One aftercreated_tois a 400.Takes a date,
YYYY-MM-DD, read as 00:00 UTC, or a date-time,YYYY-MM-DDTHH:MM[:SS]with optional fractional seconds (up to 9 digits, cut to the millisecond) andZor a+HH:MMor-HH:MMoffset. A day or time that doesn't exist, or any other form, is a 400.created_tostringOptionalFormat
date-timeOnly plans created at or before this date-time, such as
2026-11-12T06:00:00Z.Takes a date,
YYYY-MM-DD, read as 00:00 UTC, or a date-time,YYYY-MM-DDTHH:MM[:SS]with optional fractional seconds (up to 9 digits, cut to the millisecond) andZor a+HH:MMor-HH:MMoffset. A day or time that doesn't exist, or any other form, is a 400.model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
What was deleted, kept and left.
deletedintegerRequired≥ 0
Plans deleted by this call:
idscounted.keptintegerRequired≥ 0
Matching plans left because they are saved or shared.
remainingintegerRequired≥ 0
Matching plans not deleted: past the 200 one call deletes, or whose delete failed. Call again until it is 0.
idsarray of stringsRequiredup to 200 items
The deleted plans, newest first.
Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean