The add-rule command adds a rule to the Observer process.

JSON Input Data Format
{
    "id": string
    "rule": string
}
id * Specifies the ID of the Collector.
rule * Specifies the rule string, which must follow the format:

QUERY;EVENTHUB;ACTION

  • QUERY
    Specifies the search query for the rule.
  • EVENTHUB
    Specifies the ID of the Event Hub where an event will be raised. Use None if no event should be raised.
  • ACTION
    Specifies the action of the Nexus Server when an event is triggered. Use None if no action should be applied. Please note that if your source type is instance or skynde, this should always be set to None.
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": "The process was successfully completed"
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}