Sign in

v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
rule

Get Rule by ID

Returns the rule from the specified ID.

get/streaming/v2/rules/{id}

Path parameters

idstring uuid required

ID of the rule to fetch

Query parameters

renderedboolean

Whether to render rules' conditions or not. If omitted or set to false, the conditions might be returned in their raw format

Response

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