Vigilfield Docs
API referenceRules

`POST /rules/apply` — make the rules managed by `managed_by` match `rules` (ADR-0072 §3): create, update and delete by key. Idempotent; answers with what it did.

POST/rules/apply

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

POST /rules/plan and POST /rules/apply (ADR-0072 §3): every rule one repository declares, under the scope that names the repository.

Response Body

application/json

curl -X POST "https://example.com/rules/apply" \  -H "Content-Type: application/json" \  -d '{    "managed_by": "string",    "rules": [      {        "name": "string"      }    ]  }'
{  "create": [    "string"  ],  "delete": [    "string"  ],  "managed_by": "string",  "unchanged": [    "string"  ],  "update": [    "string"  ]}

`GET /queries` — list queries for the org. GET

Previous Page

`POST /rules/{id}/backtests` — run the rule over past data (ADR-0072 §5). Starts on the rule tick's next pass like a manual run; read it back with `GET /rules/{id}/runs`, and its matches with `GET /queries/{query_id}/results`. No alert is raised and the rule itself does not change. POST

Next Page