v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
rule

Get all Rules

Returns all rules in the system that the user has access to.

get/streaming/v2/rules

Query parameters

namestring

Name of the rule to fetch

Response

List of rules returned

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"
      }
    ]
  }
]