API

Get instruction

Retrieve a single watch instruction by its numeric ID.

GET/instructions/{id}

Use this endpoint to fetch one instruction by ID. The response includes the original DSL script and the compiled rule JSON.

Path

idintegerrequiredpath

The numeric instruction ID.

curl http://localhost:8081/instructions/1

{
  "id": 1,
  "name": "HighValueTransaction",
  "text": "rule HighValueTransaction {\n    description \"Review any transaction above $10,000\"\n    when amount > 10000\n    then review\n         score   0.5\n         reason  \"Amount exceeds threshold\"\n}",
  "description": "Review any transaction above $10,000",
  "dsl_json": "{\"name\":\"HighValueTransaction\",\"when\":[...],\"then\":{...}}",
  "created_at": "2026-03-16T10:00:00Z",
  "updated_at": "2026-03-16T10:00:00Z"
}

Invalid instruction ID: abc

instruction with ID 99 not found

Failed to retrieve instruction

Response

idinteger

Auto-generated instruction ID.

namestring

Unique rule name.

textstring

Original Watch DSL script text.

descriptionstring

Rule description from the DSL script, if provided.

dsl_jsonstring

Compiled rule JSON used during transaction evaluation.

created_atstring

ISO 8601 timestamp of when the instruction was created.

updated_atstring

ISO 8601 timestamp of when the instruction was last updated.