Sign in

v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
rule

Create a Rule

Creates a new rule. Duplicate rules are not allowed.

post/streaming/v2/rules

Request body

namestring required

The name of the rule

descriptionstring

Optional description of the rule

protocolstring required

Protocol the rule applies to

networkstring required

Network context of the rule

typestring required

The rule type

isActiveboolean

Whether the rule is active or not

safeDistanceinteger

Safety distance parameter

safeTimeoutinteger

Safety timeout parameter

condition_type'antlr' | 'match_var' required

Type of condition syntax used

targetstring uuid required

ID of the target associated with the rule

Example request

{
  "condition": [
    {
      "variable_type": "addresses",
      "variable_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Response

Rule created

idstring uuid
namestring required
descriptionstring
protocolstring required
networkstring required
typestring required
isActiveboolean
safeDistanceinteger
safeTimeoutinteger
condition_type'antlr' | 'match_var' required
targetstring uuid required
created_atstring date-time
updated_atstring date-time

Example response

{
  "condition": [
    {
      "variable_type": "addresses",
      "variable_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}