create

POST 
/rules

create

Request

application/json

Bodyrequired

namestringrequired
severitystring

Possible values: [info, warning, critical]

descriptionstring
processablestring
Possible values: [enabled, disabled]
Default value: enabled
tags object[]
Array [
labelstringrequired
labelValuestringrequired
metadataobject
Other custom properties associated to the tag
]
notification objectrequired
messages object[]required
Array [
policystringrequired
Possible values: [trigger, reentry]
mediumstringrequired
Possible values: [email, telegram, sms, slack, discord, fcm, msteams]
textstringrequired
]
conditions object[]required
Array [
params objectrequired
oneOf
ThresholdConditionParamsDto
metricstringrequired
URN of the metric to be monitored
Example: urn:cpt:smartdevice:nid:D0CF5EFFFE26FDAB1:onoff
thresholdnumberrequired
comparisonOperatorstringrequired
Possible values: [>, >=, <, <=, ==, !=]
unitstring
Example: °C
durationSecsnumberrequired
Possible values: >= 0
activeWindow object
fromstringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 08:10
tostringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 13:15
timezonestringrequired
IANA timezone identifier
Example: Europe/Rome
LastMessageOlderThanConditionParamsDto
channelIdstringrequired
durationSecsnumberrequired
Possible values: >= 0
activeWindow object
fromstringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 08:10
tostringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 13:15
timezonestringrequired
IANA timezone identifier
Example: Europe/Rome
typestringrequired
Possible values: [threshold, lastMessageOlderThan]
]

Responses

201

application/json

Schema

Schema

conditions object[]required
Array [
params objectrequired
oneOf
ThresholdConditionParamsDto
metricstringrequired
URN of the metric to be monitored
Example: urn:cpt:smartdevice:nid:D0CF5EFFFE26FDAB1:onoff
thresholdnumberrequired
comparisonOperatorstringrequired
Possible values: [>, >=, <, <=, ==, !=]
unitstring
Example: °C
durationSecsnumberrequired
Possible values: >= 0
activeWindow object
fromstringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 08:10
tostringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 13:15
timezonestringrequired
IANA timezone identifier
Example: Europe/Rome
LastMessageOlderThanConditionParamsDto
channelIdstringrequired
durationSecsnumberrequired
Possible values: >= 0
activeWindow object
fromstringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 08:10
tostringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
Example: 13:15
timezonestringrequired
IANA timezone identifier
Example: Europe/Rome
statusstringrequired
Possible values: [active, inactive]
createdAtstring<date-time>required
updatedAtstring<date-time>required
deletedAtstring<date-time>required
typestringrequired
Possible values: [threshold, lastMessageOlderThan]
idstringrequired
]
tags object[]required
Array [
createdAtstring<date-time>required
updatedAtstring<date-time>required
deletedAtstring<date-time>required
labelstringrequired
labelValuestringrequired
metadataobject
Other custom properties associated to the tag
idstringrequired
]
statusstringrequired

Possible values: [active, inactive]

createdAtstring<date-time>required
updatedAtstring<date-time>required
deletedAtstring<date-time>required
namestringrequired
severitystring

Possible values: [info, warning, critical]

descriptionstring
processablestring
Possible values: [enabled, disabled]
Default value: enabled
notification objectrequired
messages object[]required
Array [
policystringrequired
Possible values: [trigger, reentry]
mediumstringrequired
Possible values: [email, telegram, sms, slack, discord, fcm, msteams]
textstringrequired
]
idstringrequired

Example (auto)

{
  "conditions": [
    {
      "params": {
        "metric": "urn:cpt:smartdevice:nid:D0CF5EFFFE26FDAB1:onoff",
        "threshold": 0,
        "comparisonOperator": ">",
        "unit": "°C",
        "durationSecs": 0,
        "activeWindow": {
          "from": "08:10",
          "to": "13:15",
          "timezone": "Europe/Rome"
        }
      },
      "status": "active",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "deletedAt": "2024-07-29T15:51:28.071Z",
      "type": "threshold",
      "id": "string"
    }
  ],
  "tags": [
    {
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "deletedAt": "2024-07-29T15:51:28.071Z",
      "label": "string",
      "labelValue": "string",
      "metadata": {},
      "id": "string"
    }
  ],
  "status": "active",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "deletedAt": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "severity": "info",
  "description": "string",
  "processable": "enabled",
  "notification": {
    "messages": [
      {
        "policy": "trigger",
        "medium": "email",
        "text": "string"
      }
    ]
  },
  "id": "string"
}

400

Missing user identity id

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://connhex.com/rules");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"severity\": \"info\",\n  \"description\": \"string\",\n  \"processable\": \"enabled\",\n  \"tags\": [\n    {\n      \"label\": \"string\",\n      \"labelValue\": \"string\",\n      \"metadata\": {}\n    }\n  ],\n  \"notification\": {\n    \"messages\": [\n      {\n        \"policy\": \"trigger\",\n        \"medium\": \"email\",\n        \"text\": \"string\"\n      }\n    ]\n  },\n  \"conditions\": [\n    {\n      \"params\": {\n        \"metric\": \"urn:cpt:smartdevice:nid:D0CF5EFFFE26FDAB1:onoff\",\n        \"threshold\": 0,\n        \"comparisonOperator\": \">\",\n        \"unit\": \"°C\",\n        \"durationSecs\": 0,\n        \"activeWindow\": {\n          \"from\": \"08:10\",\n          \"to\": \"13:15\",\n          \"timezone\": \"Europe/Rome\"\n        }\n      },\n      \"type\": \"threshold\"\n    }\n  ]\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Body required

{
  "name": "string",
  "severity": "info",
  "description": "string",
  "processable": "enabled",
  "tags": [
    {
      "label": "string",
      "labelValue": "string",
      "metadata": {}
    }
  ],
  "notification": {
    "messages": [
      {
        "policy": "trigger",
        "medium": "email",
        "text": "string"
      }
    ]
  },
  "conditions": [
    {
      "params": {
        "metric": "urn:cpt:smartdevice:nid:D0CF5EFFFE26FDAB1:onoff",
        "threshold": 0,
        "comparisonOperator": ">",
        "unit": "°C",
        "durationSecs": 0,
        "activeWindow": {
          "from": "08:10",
          "to": "13:15",
          "timezone": "Europe/Rome"
        }
      },
      "type": "threshold"
    }
  ]
}