Create a saved-query, finding, or certificate alert rule.

curl --request POST \
  --url https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "destination_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "enabled": true,
  "event_types": [],
  "group_wait_seconds": 1800,
  "name": "<string>",
  "notify_resolved": true,
  "schedule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_membership_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "certificate_rule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "count_threshold": 1,
  "escalation_after_seconds": 302550,
  "finding_filter": {
    "confidences": [],
    "exposure_kinds": [
      "<string>"
    ],
    "q": "<string>",
    "severities": [],
    "statuses": []
  },
  "repeat_interval_seconds": 302550,
  "trigger_kind": "change"
}
'

import requests

url = "https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules"

payload = {
    "destination_uuids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "enabled": True,
    "event_types": [],
    "group_wait_seconds": 1800,
    "name": "<string>",
    "notify_resolved": True,
    "schedule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assignee_membership_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "certificate_rule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "count_threshold": 1,
    "escalation_after_seconds": 302550,
    "finding_filter": {
        "confidences": [],
        "exposure_kinds": ["<string>"],
        "q": "<string>",
        "severities": [],
        "statuses": []
    },
    "repeat_interval_seconds": 302550,
    "trigger_kind": "change"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination_uuids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    enabled: true,
    event_types: [],
    group_wait_seconds: 1800,
    name: '<string>',
    notify_resolved: true,
    schedule_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    assignee_membership_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    certificate_rule_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    count_threshold: 1,
    escalation_after_seconds: 302550,
    finding_filter: {
      confidences: [],
      exposure_kinds: ['<string>'],
      q: '<string>',
      severities: [],
      statuses: []
    },
    repeat_interval_seconds: 302550,
    trigger_kind: 'change'
  })
};

fetch('https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules"

	payload := strings.NewReader("{\n  \"destination_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"enabled\": true,\n  \"event_types\": [],\n  \"group_wait_seconds\": 1800,\n  \"name\": \"<string>\",\n  \"notify_resolved\": true,\n  \"schedule_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"assignee_membership_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"certificate_rule_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"count_threshold\": 1,\n  \"escalation_after_seconds\": 302550,\n  \"finding_filter\": {\n    \"confidences\": [],\n    \"exposure_kinds\": [\n      \"<string>\"\n    ],\n    \"q\": \"<string>\",\n    \"severities\": [],\n    \"statuses\": []\n  },\n  \"repeat_interval_seconds\": 302550,\n  \"trigger_kind\": \"change\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "rule": {
    "created_at": "2023-11-07T05:31:56Z",
    "destination_uuids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "enabled": true,
    "event_types": [],
    "group_wait_seconds": 1800,
    "name": "<string>",
    "notify_resolved": true,
    "revision": 2,
    "schedule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assignee_membership_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "certificate_rule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "count_threshold": 1,
    "escalation_after_seconds": 302550,
    "finding_filter": {
      "confidences": [],
      "exposure_kinds": [
        "<string>"
      ],
      "q": "<string>",
      "severities": [],
      "statuses": []
    },
    "repeat_interval_seconds": 302550
  }
}

POST

https://api.infrawatch.com/api/v1

projects

{project_uuid}

alerting

rules

Create a saved-query, finding, or certificate alert rule.

curl --request POST \
  --url https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "destination_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "enabled": true,
  "event_types": [],
  "group_wait_seconds": 1800,
  "name": "<string>",
  "notify_resolved": true,
  "schedule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_membership_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "certificate_rule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "count_threshold": 1,
  "escalation_after_seconds": 302550,
  "finding_filter": {
    "confidences": [],
    "exposure_kinds": [
      "<string>"
    ],
    "q": "<string>",
    "severities": [],
    "statuses": []
  },
  "repeat_interval_seconds": 302550,
  "trigger_kind": "change"
}
'

import requests

url = "https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules"

payload = {
    "destination_uuids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "enabled": True,
    "event_types": [],
    "group_wait_seconds": 1800,
    "name": "<string>",
    "notify_resolved": True,
    "schedule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assignee_membership_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "certificate_rule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "count_threshold": 1,
    "escalation_after_seconds": 302550,
    "finding_filter": {
        "confidences": [],
        "exposure_kinds": ["<string>"],
        "q": "<string>",
        "severities": [],
        "statuses": []
    },
    "repeat_interval_seconds": 302550,
    "trigger_kind": "change"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination_uuids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    enabled: true,
    event_types: [],
    group_wait_seconds: 1800,
    name: '<string>',
    notify_resolved: true,
    schedule_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    assignee_membership_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    certificate_rule_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    count_threshold: 1,
    escalation_after_seconds: 302550,
    finding_filter: {
      confidences: [],
      exposure_kinds: ['<string>'],
      q: '<string>',
      severities: [],
      statuses: []
    },
    repeat_interval_seconds: 302550,
    trigger_kind: 'change'
  })
};

fetch('https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.infrawatch.com/api/v1/projects/{project_uuid}/alerting/rules"

	payload := strings.NewReader("{\n  \"destination_uuids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"enabled\": true,\n  \"event_types\": [],\n  \"group_wait_seconds\": 1800,\n  \"name\": \"<string>\",\n  \"notify_resolved\": true,\n  \"schedule_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"assignee_membership_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"certificate_rule_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"count_threshold\": 1,\n  \"escalation_after_seconds\": 302550,\n  \"finding_filter\": {\n    \"confidences\": [],\n    \"exposure_kinds\": [\n      \"<string>\"\n    ],\n    \"q\": \"<string>\",\n    \"severities\": [],\n    \"statuses\": []\n  },\n  \"repeat_interval_seconds\": 302550,\n  \"trigger_kind\": \"change\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "rule": {
    "created_at": "2023-11-07T05:31:56Z",
    "destination_uuids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "enabled": true,
    "event_types": [],
    "group_wait_seconds": 1800,
    "name": "<string>",
    "notify_resolved": true,
    "revision": 2,
    "schedule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assignee_membership_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "certificate_rule_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "count_threshold": 1,
    "escalation_after_seconds": 302550,
    "finding_filter": {
      "confidences": [],
      "exposure_kinds": [
        "<string>"
      ],
      "q": "<string>",
      "severities": [],
      "statuses": []
    },
    "repeat_interval_seconds": 302550
  }
}

Authorizations

X-API-Key

string

header

required

Infrawatch API key. Supply the complete key directly as the header value.

Path Parameters

project_uuid

string<uuid>

required

Body

application/json

Option 1
Option 2
Option 3

source_kind

enum<string>

required

Available options:

saved_query,

finding,

certificate

Allowed value: "saved_query"

destination_uuids

string<uuid>[]

required

Minimum array length: 1

enabled

boolean

required

event_types

enum<string>[]

required

Minimum array length: 1

Available options:

ADDED,

REMOVED,

CHANGED

group_wait_seconds

integer

required

Required range: 0 <= x <= 3600

name

string

required

Required string length: 1 - 160

notify_resolved

boolean

required

schedule_uuid

string<uuid>

required

severity

enum<string>

required

Available options:

low,

medium,

high,

critical

assignee_membership_uuid

string<uuid>

certificate_rule_uuid

string<uuid>

count_metric

enum<string>

Available options:

result_count,

added_count,

removed_count,

changed_count

count_operator

enum<string>

Available options:

gt,

gte,

lt,

lte,

eq

count_threshold

integer<int64>

Required range: x >= 0

escalation_after_seconds

integer

Required range: 300 <= x <= 604800

escalation_severity

enum<string>

Available options:

medium,

high,

critical

finding_filter

object

Immutable source binding for a finding rule after creation.

Show child attributes

repeat_interval_seconds

integer

Required range: 300 <= x <= 604800

trigger_kind

enum<string>

default:change

Available options:

change,

count_threshold

Response

Alert rule created.

rule

object

required

Option 1
Option 2
Option 3

Show child attributes

Start here

Search

External Surface Intelligence

Alerting

Remote Browser

Rules

Reports

Projects

Usage

Create a saved-query, finding, or certificate alert rule.

Authorizations

Path Parameters

Body

Response