POST /api/optimisation/runs/:runId/strategy-runtime-control
Account required · HTTP API reference
All endpoints · Authentication and retries · Download OpenAPI
- Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.
- pause requires a positive pauseMinutes value. activate and kill do not require pauseMinutes. The account must control the selected strategy runtime.
- Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.
Request
| Parameter | Location | Type and requirement |
|---|---|---|
runId | path | string · required |
Origin | header | string · required An origin allowed by this deployment. |
X-CSRF-Token | header | string · required Must match the CSRF cookie issued to this browser. |
Body · application/json
action required · "activate" | "pause" | "kill"pauseMinutes optional · number | stringA positive whole number of minutes. Required when action is pause.. A positive whole number of minutes. Required when action is pause.
Example
Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.
{
"action": "pause",
"pauseMinutes": 30
}curl --include \
--request POST \
'https://api.weavers.app/api/optimisation/runs/1/strategy-runtime-control' \
--cookie cookies.txt --cookie-jar cookies.txt \
--header 'Origin: https://weavers.app' \
--header "X-CSRF-Token: ${CSRF_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @request.jsonResponses
200 · Successful response.
application/json
{
"runId": "1",
"strategyId": "11111111-1111-4111-8111-111111111111",
"autoExecution": {
"scope": "paper",
"state": "active",
"pauseUntil": null,
"reason": null,
"updatedAt": null
}
}View response model
runId required · stringstrategyId required · stringautoExecution required · objectView autoExecution model
scope required · "paper"state required · "active" | "paused" | "killed"pauseUntil required · null | stringView pauseUntil model
Variant 1: null
null
Variant 2: string
string
reason required · null | stringView reason model
Variant 1: null
null
Variant 2: string
string
updatedAt required · null | stringView updatedAt model
Variant 1: null
null
Variant 2: string
string
Additional fields: JSON values.
Additional fields: JSON values.
400 · Invalid request.
application/json
{
"error": "example",
"code": "example"
}View response model
Variant 1: object
error required · stringcode required · stringAdditional fields: JSON values.
401 · Authentication is missing or invalid.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
403 · Permission, origin or CSRF check failed.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
429 · Rate limit reached; honor Retry-After when supplied.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
500 · Server failure.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
default · Operation-specific error. Inspect error/code before deciding whether to retry.
application/json
{
"error": "example",
"code": "example"
}View response model
error required · stringcode required · stringAdditional fields: JSON values.