Rules can be managed using REST API.

Rule creation

A new rule can be created with REST API query /api/rule/create

https://hostname:8090/api/rule/create
{
  "type": "0",
  "name": "rule1",
  "value": ".*",
  "profiles": ["14", "17"]
}

Where

• type – rule type:
  • 0 – stream name template
  • 1 - reserved
• name – rule name
• value – rule value (template for type 0)
• profiles – list of identifiers of profiles, to which the rule should be applied

Rule changing

A rule can be changed with REST API query /api/rule/update

https://hostname:8090/api/rule/update
{
  "id": "13",
  "type": "0",
  "name": "rule1",
  "value": ".*",
  "profiles": ["14", "17"]
}

Where

• id – rule identifier
• type – rule type (0 or 1)
• name – rule name
• value – rule value (template for type 0)
• profiles – list of identifiers of profiles, to which the rule should be applied

Rule deletion

A rule can be deleted with REST API query /api/rule/delete

https://hostname:8090/api/rule/delete
{
  "id": "13"
}

Where

• id – rule identifier

Obtaining rule information

A rule information can be obtained with REST API query /api/rule/list

https://hostname:8090/api/rule/list
{
  "id": "13",
  "profile": "17"
}

Where

• id – rule identifier
• profile - profile identifier

If rule Id is set, the response will contain only that rule information. If profile Id is set, the response will contain information only about the rules applied to that profile metrics. If none of Ids is set, the response will contain list with all the rules on backend server.

For every rule, the response contains the same fields as /api/rule/update query.