kibana/api_docs/kbn_securitysolution_rules.devdocs.json

{
  "id": "@kbn/securitysolution-rules",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.flattenWithPrefix",
        "type": "Function",
        "tags": [],
        "label": "flattenWithPrefix",
        "description": [],
        "signature": [
          "(prefix: string, maybeObj: unknown) => Record<string, SearchTypes>"
        ],
        "path": "packages/kbn-securitysolution-rules/src/utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.flattenWithPrefix.$1",
            "type": "string",
            "tags": [],
            "label": "prefix",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "packages/kbn-securitysolution-rules/src/utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.flattenWithPrefix.$2",
            "type": "Unknown",
            "tags": [],
            "label": "maybeObj",
            "description": [],
            "signature": [
              "unknown"
            ],
            "path": "packages/kbn-securitysolution-rules/src/utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.isRuleType",
        "type": "Function",
        "tags": [],
        "label": "isRuleType",
        "description": [],
        "signature": [
          "(ruleType: unknown) => ruleType is \"query\" | \"eql\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.isRuleType.$1",
            "type": "Unknown",
            "tags": [],
            "label": "ruleType",
            "description": [],
            "signature": [
              "unknown"
            ],
            "path": "packages/kbn-securitysolution-rules/src/utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.isRuleTypeId",
        "type": "Function",
        "tags": [],
        "label": "isRuleTypeId",
        "description": [],
        "signature": [
          "(ruleTypeId: unknown) => ruleTypeId is ",
          {
            "pluginId": "@kbn/securitysolution-rules",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionRulesPluginApi",
            "section": "def-common.RuleTypeId",
            "text": "RuleTypeId"
          }
        ],
        "path": "packages/kbn-securitysolution-rules/src/utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.isRuleTypeId.$1",
            "type": "Unknown",
            "tags": [],
            "label": "ruleTypeId",
            "description": [],
            "signature": [
              "unknown"
            ],
            "path": "packages/kbn-securitysolution-rules/src/utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.EQL_RULE_TYPE_ID",
        "type": "string",
        "tags": [],
        "label": "EQL_RULE_TYPE_ID",
        "description": [],
        "signature": [
          "\"siem.eqlRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.INDICATOR_RULE_TYPE_ID",
        "type": "string",
        "tags": [],
        "label": "INDICATOR_RULE_TYPE_ID",
        "description": [],
        "signature": [
          "\"siem.indicatorRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.MAX_EXECUTION_EVENTS_DISPLAYED",
        "type": "number",
        "tags": [],
        "label": "MAX_EXECUTION_EVENTS_DISPLAYED",
        "description": [
          "\nMax number of execution events to aggregate in memory for the Rule Execution Log"
        ],
        "signature": [
          "1000"
        ],
        "path": "packages/kbn-securitysolution-rules/src/configuration_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.ML_RULE_TYPE_ID",
        "type": "string",
        "tags": [],
        "label": "ML_RULE_TYPE_ID",
        "description": [],
        "signature": [
          "\"siem.mlRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.NEW_TERMS_RULE_TYPE_ID",
        "type": "string",
        "tags": [],
        "label": "NEW_TERMS_RULE_TYPE_ID",
        "description": [],
        "signature": [
          "\"siem.newTermsRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.QUERY_RULE_TYPE_ID",
        "type": "string",
        "tags": [],
        "label": "QUERY_RULE_TYPE_ID",
        "description": [],
        "signature": [
          "\"siem.queryRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.RuleType",
        "type": "Type",
        "tags": [],
        "label": "RuleType",
        "description": [],
        "signature": [
          "\"query\" | \"eql\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.RuleTypeId",
        "type": "Type",
        "tags": [],
        "label": "RuleTypeId",
        "description": [],
        "signature": [
          "\"siem.eqlRule\" | \"siem.indicatorRule\" | \"siem.mlRule\" | \"siem.queryRule\" | \"siem.savedQueryRule\" | \"siem.thresholdRule\" | \"siem.newTermsRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.SAVED_QUERY_RULE_TYPE_ID",
        "type": "string",
        "tags": [],
        "label": "SAVED_QUERY_RULE_TYPE_ID",
        "description": [],
        "signature": [
          "\"siem.savedQueryRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.SIGNALS_ID",
        "type": "string",
        "tags": [],
        "label": "SIGNALS_ID",
        "description": [
          "\nId for the legacy siem signals alerting type"
        ],
        "signature": [
          "\"siem.signals\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.THRESHOLD_RULE_TYPE_ID",
        "type": "string",
        "tags": [],
        "label": "THRESHOLD_RULE_TYPE_ID",
        "description": [],
        "signature": [
          "\"siem.thresholdRule\""
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/securitysolution-rules",
        "id": "def-common.ruleTypeMappings",
        "type": "Object",
        "tags": [],
        "label": "ruleTypeMappings",
        "description": [
          "\nMaps legacy rule types to RAC rule type IDs."
        ],
        "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.ruleTypeMappings.eql",
            "type": "string",
            "tags": [],
            "label": "eql",
            "description": [],
            "signature": [
              "\"siem.eqlRule\""
            ],
            "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.ruleTypeMappings.machine_learning",
            "type": "string",
            "tags": [],
            "label": "machine_learning",
            "description": [],
            "signature": [
              "\"siem.mlRule\""
            ],
            "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.ruleTypeMappings.query",
            "type": "string",
            "tags": [],
            "label": "query",
            "description": [],
            "signature": [
              "\"siem.queryRule\""
            ],
            "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.ruleTypeMappings.saved_query",
            "type": "string",
            "tags": [],
            "label": "saved_query",
            "description": [],
            "signature": [
              "\"siem.savedQueryRule\""
            ],
            "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.ruleTypeMappings.threat_match",
            "type": "string",
            "tags": [],
            "label": "threat_match",
            "description": [],
            "signature": [
              "\"siem.indicatorRule\""
            ],
            "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.ruleTypeMappings.threshold",
            "type": "string",
            "tags": [],
            "label": "threshold",
            "description": [],
            "signature": [
              "\"siem.thresholdRule\""
            ],
            "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/securitysolution-rules",
            "id": "def-common.ruleTypeMappings.new_terms",
            "type": "string",
            "tags": [],
            "label": "new_terms",
            "description": [],
            "signature": [
              "\"siem.newTermsRule\""
            ],
            "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}