POST `/api/v1/workflow/rules/{id}/test-bench`

Replay the last days of items (202: a job).

Scope workflow:rules:write
Idempotency-Key
Asynchronous
operationId workflowTestBench

The token needs the scope workflow:rules:write, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Idempotency-Key. Send a unique Idempotency-Key (up to 255 characters, e.g. a UUID) with every POST. Retrying with the same key and body replays the first answer for 24 hours, so a timeout never creates a second order; the same key with a different body is refused (idempotency_key_reused).

Asynchronous. Long operations answer 202 with a Job. Poll GET /api/v1/jobs/{id} (every 1 to 5 seconds) until status is succeeded or failed; the result is in result.

Request

POST /api/v1/workflow/rules/{id}/test-bench

Path parameters

Name	Description	Example
`id`	The id of the rule.	`41`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token
`Idempotency-Key`	yes	A unique string up to 255 characters (a UUID). Idempotency
`Content-Type`	yes	`application/json`

Body: `Days`

Field	Type	Required	Description
`days`	integer	no	How many days back to replay (default 10).

Decimals (money, prices, quantities, percentages) are sent as strings, ids as strings, times as ISO 8601 UTC.

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl -X POST "https://vestoris.com/api/v1/workflow/rules/41/test-bench" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H "Content-Type: application/json" \
  -d '{"days":10}'

Python (requests)

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/workflow/rules/41/test-bench",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    json={
        "days": 10
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/workflow/rules/41/test-bench", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "days": 10
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

202 Accepted, application/json: Job. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`kind`	string	What the job does.
`status`	string	queued, running, succeeded or failed.
`result`	any	The result when it succeeded.
`error`	string or null	The error, when it failed.
`created_at`	date-time or null	When it was created.
`started_at`	date-time or null	When it started.
`finished_at`	date-time or null	When it finished.
`poll`	string or null	Where to poll for the result.

Example response

HTTP/1.1 202 Accepted
Content-Type: application/json

{
    "id": "1042",
    "kind": "rule_test_bench",
    "status": "succeeded",
    "result": {
        "blocked": 2,
        "warned": 5,
        "accounts_in_breach": 1
    },
    "error": null,
    "created_at": "2026-10-27T14:30:00Z",
    "started_at": null,
    "finished_at": null,
    "poll": "/api/v1/jobs/88"
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
202	Accepted: a job (or the file) is being processed
200 / 201	The same Idempotency-Key again: the first answer is replayed (24 hours)
400	The request is malformed	`invalid_request` `invalid_json`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
409	Not possible in the current state	`invalid_transition` `conflict` `idempotency_in_progress`
422	Validation failed (the detail says which field), or blocked	`validation_failed` `idempotency_key_reused`
428	A required header is missing	`idempotency_key_required`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/workflow/rules/41/test-bench"
}

On the screens

The same thing in the app is explained in:

POST /api/v1/workflow/rules/{id}/test-bench