Create Rule Public Api

Create a rule in your organization.

One endpoint handles all supported rule_type values; the shape of content
must match the type (see request examples in this operation).

rule_typecontent formatNotes
sigmaYAML string or parsed Sigma objectTitle/description/tags can live in the YAML.
scheduled_sqlObject with query, schedule, entity_fieldsQuery must contain organization_id = ?.
signal_combinationObject with query, schedule, descriptionCustomer portal org only on this API.

Organization ID: External callers should omit organization_id — the rule is
created under the organization in your session. Internal portal sessions may pass
organization_id (use "*" for cross-tenant rules when omitted on internal portal).

Status: Use inactive while iterating; set active when ready to deploy.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
SigmaRuleContent | SqlRuleContent | StreamingSqlRuleContent | ScheduledSqlRuleContent | CorrelationRuleContent | SignalCombinationRuleContent
required

Rule title (will be populated from content if not provided)

Rule description (will be populated from content if not provided)

enum

Rule status (will be mapped from Sigma status if not provided)


Rule status. See RULE_LIFECYCLE.md for state transition diagram.

0 to 100

Rule severity (0-100)

tags
array of strings

Rule tags

Tags
array | null

Detection categories. None = caller omitted the field; the service layer coerces to [] before persisting so the DB never stores NULL.

array | null

Data sources. None = caller omitted the field; the service layer coerces to [] before persisting so the DB never stores NULL.

User ID

object | null

Additional rule details

Organization ID

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