Validate Rule Public Api

Validate rule content without persisting a rule.

Use this to check a SQL payload before calling POST /rules. Send content as
an object with the fields for the rule's type.
The alias rule_content is accepted in place of content.

validation_errors, validation_warnings and field_validations are written to be
read and acted on. debug carries what sits behind them — the engine payload, the
statement that was checked, a ClickHouse backtrace — for reporting a problem rather
than for display; an entry there always has a readable error beside it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request model for public rule validation without create-time requirements.

string
enum
required

Supported rule types (signal generators).

NOTE: signal-api's Postgres ruletype enum still carries labels this does not
name (SIGMA, SQL, STREAMING_SQL, CORRELATION). They are left in
place deliberately — dropping a label needs a full type rebuild — and excluded from
alembic comparison.

A stored row carrying one does not load, which is intended: no code path can
execute it. But it must not stop the rows around it loading either, and that does
not come for free — SQLAlchemy's Enum raises from its result processor, which
fails the whole SELECT rather than the one row. signal-api reads this column
through TolerantRuleTypeEnum (signal_api.models.database) for that reason.
Anything else that maps this enum onto a stored column needs the same care.

Allowed:
string | object
required

Rule content payload: an object with the fields for the rule type.

Optional title used for validation context only

Optional description used for validation context only

Headers
string
required

Your API Key ID

string

Your API Key Secret

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json